Changes between Version 10 and Version 11 of Development/CodeConventions

Show
Ignore:
Timestamp:
08/27/09 13:07:52 (5 years ago)
Author:
benl (IP: 219.127.83.145)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/CodeConventions

    v10 v11  
    1111 * We prefer literal tabs at the start of lines instead of hard spaces. 
    1212 * 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 about 1 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. 
    1414 
    1515 * 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: