Changes between Version 10 and Version 11 of Development/CodeConventions
- Timestamp:
- 08/27/09 13:07:52 (4 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Development/CodeConventions
v10 v11 11 11 * We prefer literal tabs at the start of lines instead of hard spaces. 12 12 * Each top-level definition should have a comment explaining what it is for. One liners are fine. 13 * Running comments in the bodies of functions are encouraged. Write down what you were expecting the code to do when you wrote it, so it reads like a story. Aim for about1 comment line every 5-10 code lines, depending on how complex the code is.13 * Running comments in the bodies of functions are encouraged. Write down what you were expecting the code to do when you wrote it, so it reads like a story. Aim for 1 comment line every 5-10 code lines, depending on how complex the code is. 14 14 15 15 * If a function does several things in a regular way, then it should look like that in the source code. This means you should line up arguments to similar function calls. For example, use this:
