Changes between Version 24 and Version 25 of Coding_Conventions


Ignore:
Timestamp:
Jun 1, 2014, 10:28:35 PM (10 years ago)
Author:
sanderd17
Comment:

Add comment about comments

Legend:

Unmodified
Added
Removed
Modified

  • Coding_Conventions

    v24 v25  
    167167 * Try not to repeat class names or function names in the descriptions, since that's redundant information.
    168168
     169 * Try to avoid very wide lines. As wrapped block comments are extremely unreadable. Always try to keep each line of those below 80 chars (counting tabs as 4 chars).
     170
    169171 * Don't need to bother documenting every line of code or every member function or every member variable; only when it'll add to a competent reader's understanding of the program.
    170172