Changes between Version 25 and Version 26 of Commentary/CodingStyle


Ignore:
Timestamp:
May 9, 2008 9:40:38 AM (7 years ago)
Author:
simonmar
Comment:

mention using wiki commentary rather than comments where appropriate

Legend:

Unmodified
Added
Removed
Modified
  • Commentary/CodingStyle

    v25 v26  
    7979 * Cite a test case in the test suite that illustrates it 
    8080 
     81== Longer comments or architectural commentary == 
     82 
     83Comments with a broad scope, describing the architecture or workings of more than one module, belong here in the commentary rather than in the code.  Put the URL for the relevant commentary page in a comment in the code itself, and also put URLs for all relevant commentary pages in a comment at the top of each module. 
     84 
    8185== Warnings == 
    8286