Documentation/4.1/Developers/Style Guide - Revision history

Unknown user: Text replacement - "slicerWiki/index.php" to "wiki"

2019-11-21T17:04:36Z

Text replacement - "slicerWiki/index.php" to "wiki"

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:21:16Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

Finetjul: /* Message content */

2012-06-27T17:46:59Z

Message content

Finetjul: Update Qt version

2012-06-26T01:06:42Z

Update Qt version

Finetjul: /* Language Specific */

2012-06-22T04:03:41Z

Language Specific

Finetjul: /* Naming */

2012-06-04T16:16:06Z

Naming

Finetjul: /* Commits */ Add summary

2012-05-18T05:06:35Z

Commits: Add summary

Finetjul: /* Message content */

2012-05-18T05:00:18Z

Message content

Finetjul: /* Commit message prefix */

2012-05-18T04:59:38Z

Commit message prefix

Finetjul: /* Message content */

2012-05-17T16:39:06Z

Message content

@@ Line 127: / Line 127: @@
 http://www.na-mic.org/Wiki/index.php/Engineering:Subversion_Repository
-http://www.slicer.org/slicerWiki/index.php/Slicer:git-svn
+http://www.slicer.org/wiki/Slicer:git-svn
 = UI Design Guidelines =
 {{:Documentation/{{documentation/version}}/Developers/Style Guide/UI}}

← Older revision		Revision as of 07:21, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	= Code style =		= Code style =

@@ Line 106: / Line 106: @@
   Closes #1641
 Where <code>1641</code> refers to the [http://www.na-mic.org/Bug/view.php?id=1641 issue number] in mantis
 ==Importing changes from external project/repository==

@@ Line 24: / Line 24: @@
 # Don't mix different levels of abstraction
 #: Examples:
-#:: When dealing with files names and path, use [http://vtk.org/gitweb?p=VTK.git;a=blob;f=Utilities/KWSys/vtksys/SystemTools.hxx.in;h=04f197842695c5914d1a49d4738159d3bccb08e8;hb=HEAD kwsys::SystemTools] in VTK classes, [http://doc.qt.nokia.com/4.7.4/qfileinfo.html QFileInfo]/[http://doc.qt.nokia.com/4.7.4/qdir.html QDir] in Qt classes or [http://docs.python.org/library/os.path.html os.path] in python. Instead of doing string manipulation manually:
+#:: When dealing with files names and path, use [http://vtk.org/gitweb?p=VTK.git;a=blob;f=Utilities/KWSys/vtksys/SystemTools.hxx.in;h=04f197842695c5914d1a49d4738159d3bccb08e8;hb=HEAD kwsys::SystemTools] in VTK classes, [http://doc.qt.nokia.com/{{documentation/{{documentation/version}}/qtversion}}/qfileinfo.html QFileInfo]/[http://doc.qt.nokia.com/{{documentation/{{documentation/version}}/qtversion}}/qdir.html QDir] in Qt classes or [http://docs.python.org/library/os.path.html os.path] in python. Instead of doing string manipulation manually:
 #:::<code>QString filePath = directoryPath + "/" + fileName + ".exe"</code>)
 #:: prefer instead:
@@ Line 34: / Line 34: @@
 #:* http://zuskin.com/coding_habits__functions.htm#Abstraction_levels
 # Use STL where you can, but follow the VTK [http://www.vtk.org/Wiki/VTK_FAQ#Can_I_use_STL_with_VTK.3F guidelines]
-## However, prefer [http://doc.qt.nokia.com/4.7-snapshot/containers.html Qt Container classes] to STL classes in Qt files
+## However, prefer [http://doc.qt.nokia.com/{{documentation/{{documentation/version}}/qtversion}}/containers.html Qt Container classes] to STL classes in Qt files
 ## Note that a [http://www.vtk.org/doc/nightly/html/classvtkCollection.html vtkCollection] is somewhat equivalent to <code>std::list<vtkSmartPointer<vtkObject*> ></code>
 == Language Specific ==

@@ Line 40: / Line 40: @@
 # [[Documentation/{{documentation/version}}/Developers/Style Guide/Cpp | C++]]
 # [[Documentation/{{documentation/version}}/Developers/Style Guide/Python | Python]]
 == Library Dependencies ==

@@ Line 5: / Line 5: @@
 == Naming ==
-# Acronyms should be written in all CAPS.
+# Acronyms should be written with the same case for each letter (all uppercase or all lowercase).
 #: ''RASToSlice'' not ''RasToSlice''
 #: ''vtkMRML'' not ''vtkMrml''
 # Words should be spelled out and not abreviated
 #: ''GetWindow'' not ''GetWin''
 == Comments ==

@@ Line 57: / Line 57: @@
 = Commits =
 ==Commit message prefix==
 Subversion Commits to Slicer require commit type in the comment.

@@ Line 90: / Line 90: @@
 *Good: <code>COMP: Fix compilation error with Numpy on Visual Studio</code>
-If the commit is related to a [http://na-mic.org/Mantis/view_all_bug_page.php mantis issue] (bug or feature request), you can mention it in the commit message body by preceding the issue number with a '''#''' character:
+If the commit is related to a [http://na-mic.org/Mantis/view_all_bug_page.php mantis issue] (bug or feature request), you can mention it in the commit message body by preceding the issue number with a '''#'''(pound) character:
   BUG: Fix crash in Volume Rendering module when switching view layout

@@ Line 59: / Line 59: @@
 ==Commit message prefix==
 Subversion Commits to Slicer require commit type in the comment.
 Valid commit types are:
     BUG:   - a change made to fix a runtime issue
@@ Line 67: / Line 68: @@
     STYLE: - a change that does not impact the logic or execution of the code.
              (improve coding style, comments, documentation).
 The Subversion command to commit the change is: