Slicer3:Style - Revision history

Grundlett: Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/"

2017-07-10T18:07:26Z

Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/"

Marianna: Unprotected "Slicer3:Style"

2008-05-20T17:44:18Z

Marianna: Replacing page with ''''Note:''' We are migrating this content to the slicer.org domain - The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Style here...'

2008-05-20T17:44:04Z

Replacing page with '<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Style here...'

Pieper: /* General Considerations */

2007-07-23T12:27:19Z

General Considerations

Pieper at 20:21, 14 March 2007

2007-03-14T20:21:27Z

Pieper at 17:10, 9 January 2007

2007-01-09T17:10:50Z

Pieper at 21:45, 3 January 2007

2007-01-03T21:45:45Z

Pieper at 19:54, 28 December 2006

2006-12-28T19:54:01Z

Pieper at 19:49, 28 December 2006

2006-12-28T19:49:47Z

Pieper at 19:48, 28 December 2006

2006-12-28T19:48:28Z

← Older revision		Revision as of 18:07, 10 July 2017
Line 1:		Line 1:
−	<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [~~http~~://www.slicer.org/~~slicerWiki/index.php~~/Slicer3:Style here]</font></big>	+	<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>

← Older revision		Revision as of 17:44, 20 May 2008
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 [http://www.slicer.org/slicerWiki/index.php/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 by first 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 hierarchies
−	* comment your code extensively
−	* ''do not leave dead code'' in the source files. Large blocks of commented out code makes the source file hard to read. Instead, include a comment that points to ~~a previous revision number in svn that has~~ the ~~previous revision you are removing.~~
−
−	~~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.~~

@@ Line 3: / Line 3: @@
 A few things to keep in mind:
-* All C++ classes must conform to the style conventions of their parent classes.
+* 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.
@@ Line 9: / Line 9: @@
 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'' )
+** ''acronyms should be capitalized as a whole'', not by first 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 hierarchies
 * comment your code extensively
 Code that will be included in slicer must use CMake for cross platform building.

@@ Line 1: / Line 1: @@
 A few things to keep in mind:
@@ Line 15: / Line 17: @@
 Code that will be included in slicer must use CMake for cross platform building.
 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]].

@@ Line 8: / Line 8: @@
 Highlights of the policies:
 * avoid acronyms in class and method names
 * use 2 spaces for indentation, not tabs
 * think carefully about the reusability of your class hierarcies

← Older revision	Revision as of 17:44, 20 May 2008
(No difference)

← Older revision		Revision as of 19:48, 28 December 2006
Line 12:		Line 12:

	Code is released under the [http://slicer.org/copyright/copyright.txt slicer license].		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]].