Difference between revisions of "Slicer3:Style"
From NAMIC Wiki
Line 8: | Line 8: | ||
Highlights of the policies: | Highlights of the policies: | ||
* avoid acronyms in class and method names | * avoid acronyms in class and method names | ||
+ | ** some standard acronyms can be use (IJK, RAS, MRML, etc) | ||
+ | ** acronyms should be capitalized as a whole, not be letter (e.g. RASToIJK is correct -- RasToIjk ''is not correct'' ) | ||
* use 2 spaces for indentation, not tabs | * use 2 spaces for indentation, not tabs | ||
* think carefully about the reusability of your class hierarcies | * think carefully about the reusability of your class hierarcies |
Revision as of 17:10, 9 January 2007
Home < Slicer3:StyleA few things to keep in mind:
- All C++ classes must conform to the style conventions of their parent classes.
- In most cases for Slicer Base, this means following VTK coding conventions including naming, indentation, and other issues discussed at the VTK Coding Standards page. This means using the VTK two-space indent style (even if you don't like it!).
- For command line modules implemented in ITK, follow the conventions defined in Insight/Documentation/Style.pdf from the ITK distribution.
- Libraries (such as Teem, zlib, etc) may follow their own coding styles, and be wrapped with in classes with the appropriate styles.
Highlights of the policies:
- avoid acronyms in class and method names
- some standard acronyms can be use (IJK, RAS, MRML, etc)
- acronyms should be capitalized as a whole, not be letter (e.g. RASToIJK is correct -- RasToIjk is not correct )
- use 2 spaces for indentation, not tabs
- think carefully about the reusability of your class hierarcies
- comment your code extensively
Code that will be included in slicer must use CMake for cross platform building.
Code is released under the slicer license.
All NA-MIC funded software, data, documentation, and other materials should include the NIH Roadmap acknowledgement.