Changes between Version 4 and Version 5 of ControlSystems/SoftwareTeam/CodingConventions
- Timestamp:
- Oct 31, 2019, 9:03:59 PM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ControlSystems/SoftwareTeam/CodingConventions
v4 v5 14 14 * Define each parameter 15 15 * document your code thoroughly so someone else can read and understand it. Good code contains at least as many lines of ''good'' comments as of executable code...no matter how readable you think your code is. 16 * clean up your code before you check it in. 17 * Don't leave gobs of test code and debug print statements in your code. When you make your code available to others, that should all be removed and the code 18 should be clean and readable. 16 * clean up your code '''before''' you check it in. Don't leave gobs of test code and debug print statements in your code. When you make your code available to others, that should all be removed and the code should be clean and readable. 19 17 20 18 == Software Culture ==