These coding standards were selected to ensure quality code.
| Readability |
All code should be easy to read and understand.
A knowledgeable user should be able to look at a section of code and quickly
determine the purpose of the code and how it works. |
| Consistency |
Using coding standards ensures consistency throughout
code created by multiple developers or by the same developer at different times.
These standards avoid the confusion and frustration of having pieces of code
look completely different simply because they were created by different people.
|
| Predictability |
When code is written in a consistent form, the code
organization and structure are predictable. Users can easily determine where
to find a particular piece of functionality because its location is established
by the standards. |
| Conciseness |
Coding standards encourage clear, succinct, and
efficient code, written as simply as possible, with sufficient amounts of
comments and spacing. |
| Maintainability |
Clean, well-designed code is easier to maintain and
update. Properly documented and structured code is also easier for other developers to understand.. |
| Efficiency |
Coding standards support developing code that is as
fast and efficient as possible, encouraging developers to study and craft each
line of code and to use the most effective implementation possible. |
| Professionalism |
Coding standards encourage professionalism by keeping
the coding style consistent among developers, avoiding facetious functions and
variable names, and improving code readability. |
