Changes between Version 1 and Version 2 of CodingStandards
- Timestamp:
- Dec 31, 1969, 4:20:58 PM (55 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
CodingStandards
v1 v2 2 2 Good code is not only well-written, efficient, and well-documented, but also is written with a uniform formatting standard. Below I outline some suggested coding standards we all try to stick with in order to provide a uniform and clean look and feel to our source code files. Please feel free to update this if you feel strongly about a certain topic, these rules are meant to serve as a starting point only. 3 3 4 Many of the configurations recommended below can be set within your IDE of choice. 5 4 6 == Syntax == 5 7 6 '''Tab Stop''' : Tab indentation shall be set to 4 spaces (following general Tab-Stop space calculation rules). Usage of space characters is highly encouraged however a tab character is also acceptable.8 '''Tabs''' : Use tabs, not spaces. This allows individuals to adjust indentation to their liking, 7 9 8 10 '''Line Length''' : A single line of code shall not exceed the 80 character printable page width. This rule helps when printing the page, or when viewing the code on a fixed-width terminal.