Skip to topic
|
Skip to bottom
Jump:
TModeling
TModeling Web
TModeling Web Home
Changes
Notify
Index
Search
Webs
BioGeometry
Main
TModeling
TWiki
Edit
Attach
Printable
TModeling.StyleGuide
r1.1 - 16 Jun 2008 - 03:27 - Main.guest
topic end
Start of topic |
Skip to actions
*Style Guide* --- An overview of general guidelines to follow when writing our code to help figure out the underlying logical structure, improve consistency, readability, and maintainability of our source code _Note:_ Developers often have strong opinions on how code should be written. These guidelines are not meant to provoke a religious war on the correct way to format code. Merely to provide a consistent framework for development of our code over time by many different students. It's harder for new students to read and understand code that changes style frequently (depending on the original author). --- * [[Layout Guide]] - Layout guidelines * [[Naming Conventions]] - Guidelines on naming variables, functions, methods, classes, etc. * [[Comments]] - Guidelines on using comments * [[Special Cases]] - Various special cases that require a consistent style decision. --- * [[Writing Self-Documenting Code]] - Brief overview of how to reduce the need for comments by increasing the readability of the code itself. -- Main.ShawnDB - 15 Jun 2008
to top
End of topic
Skip to action links
|
Back to top
Edit
|
Attach image or document
|
Printable version
|
Raw text
|
More topic actions
Revisions: | r1.1
|
Total page history
|
Backlinks
You are here:
TModeling
>
StyleGuide
to top
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki?
Send feedback