Difference between revisions of "Slicer3:Style"

From NAMIC Wiki
Jump to: navigation, search
m (Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/")
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== General Considerations ==
+
<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [https://www.slicer.org/wiki/Slicer3:Style here]</font></big>
 
 
A 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 [http://www.vtk.org/Wiki/VTK_Coding_Standards 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 [[media:Style.pdf | 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.
 
 
 
== Licensing ==
 
 
 
Code is released under the [http://slicer.org/copyright/copyright.txt slicer license].
 
 
 
All NA-MIC funded software, data, documentation, and other materials should include [[Publications:NIH_Roadmap_acknowledgement | the NIH Roadmap acknowledgement]].
 
 
 
Please add acknowledgements for any and all grants that helped fund your development work. See [[Slicer3:Acknowledgements]] for lists of grants and grant numbers.
 

Latest revision as of 18:07, 10 July 2017

Home < Slicer3:Style

Note: We are migrating this content to the slicer.org domain - The newer page is here