Documentation/4.0/Developers/Style Guide/Cpp - Revision history

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

2013-06-14T07:31:07Z

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

Finetjul at 13:56, 9 April 2012

2012-04-09T13:56:11Z

JChris.FillionR: moved Documentation/4.0/Developers/Slicer C++ Style Guide to Documentation/4.0/Developers/Style Guide/Cpp

2012-03-27T17:45:25Z

moved Documentation/4.0/Developers/Slicer C++ Style Guide to Documentation/4.0/Developers/Style Guide/Cpp

JChris.FillionR at 21:45, 7 February 2012

2012-02-07T21:45:13Z

JChris.FillionR at 19:04, 20 December 2011

2011-12-20T19:04:31Z

JChris.FillionR: /* Tools */

2011-11-03T06:01:48Z

Tools

JChris.FillionR at 06:00, 3 November 2011

2011-11-03T06:00:24Z

JChris.FillionR: /* References */

2011-11-03T05:48:01Z

References

JChris.FillionR: /* Tools */

2011-11-03T05:45:53Z

Tools

JChris.FillionR: Created page with 'Developers Information← {{ambox | type = protection | image = alt=Work in progress | te…'

2011-11-03T05:45:06Z

Created page with '[[Documentation/{{documentation/version}}/Developers|Developers Information]]← {{ambox | type = protection | image = 40px|alt=Work in progress | te…'

New page

[[Documentation/{{documentation/version}}/Developers|Developers Information]]←

{{ambox
| type = protection
| image = [[File:InProgress.png|40px|alt=Work in progress]]
| text = Page under construction.
}}

= References =

= Tools =

← Older revision		Revision as of 07:31, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	{{documentation/underconstruction}}		{{documentation/underconstruction}}

← Older revision		Revision as of 13:56, 9 April 2012
Line 1:		Line 1:
	{{documentation/underconstruction}}		{{documentation/underconstruction}}
		+
		+	= Indentation =
		+	Configure your text editor to do VTK style indentation:
		+	* [http://www.vtk.org/Wiki/Elisp_Code_for_VTK-Style_C_Indentation Emacs]
		+	* [http://wiki.na-mic.org/Wiki/index.php/User:Pieper Vi/Vim]
		+	* [http://www.vtk.org/Wiki/VTK_FAQ#How_do_I_get_my_C.2B.2B_code_editor_to_do_VTK-style_indentation.3F Visual Studio]
		+
		+	= Naming =
		+	* Local variable should start with a lower case.
		+	** For example:
		+
		+	void vtkSlicerSliceLogic::SetForegroundLayer(vtkSlicerSliceLayerLogic *ForegroundLayer) // wrong!
		+
		+	should be
		+
		+	void vtkSlicerSliceLogic::SetForegroundLayer(vtkSlicerSliceLayerLogic *foregroundLayer)
		+
		+	* Member variable should start with a capital letter, and in implementation should be used in conjunction with 'this->' convention
		+	** For example
		+
		+	class Node {
		+	Object &Foo();
		+	Object Bla;
		+	};
		+	Object& Node::Foo()
		+	{
		+	return this->Bla;
		+	}
		+

	= References =		= References =

← Older revision		Revision as of 21:45, 7 February 2012
Line 1:		Line 1:
−	~~[[Documentation/{{documentation/version}}/Developers\|Developers Information]]←~~
−
	{{documentation/underconstruction}}		{{documentation/underconstruction}}

@@ Line 1: / Line 1: @@
 [[Documentation/{{documentation/version}}/Developers|Developers Information]]&larr;
-{{ambox
+{{documentation/underconstruction}}
 = References =

@@ Line 31: / Line 31: @@
 OK, enough writing about writing code; the code itself is much more interesting. Have fun!
-<i>Source: [https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml{{!}}Google C++ Style Guide]</i>
+<i>Source: [https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml Google C++ Style Guide]</i>
 }}

← Older revision	Revision as of 17:45, 27 March 2012
(No difference)

← Older revision		Revision as of 06:00, 3 November 2011
Line 15:		Line 15:
	* http://universalindent.sourceforge.net/		* http://universalindent.sourceforge.net/
	* http://uncrustify.sourceforge.net/		* http://uncrustify.sourceforge.net/
		+
		+
		+
		+
		+
		+	{{ambox\|text=
		+	Use common sense and BE CONSISTENT.
		+
		+	If you are editing code, take a few minutes to look at the code around you and determine its style.
		+	If they use spaces around their if clauses, you should, too.
		+	If their comments have little boxes of stars around them, make your comments have little boxes of stars around them too.
		+
		+	The point of having style guidelines is to have a common vocabulary of coding so people can concentrate on what you are saying, rather than on how you are saying it. We present global style rules here so people know the vocabulary. But local style is also important. If code you add to a file looks drastically different from the existing code around it, the discontinuity throws readers out of their rhythm when they go to read it. Try to avoid this.
		+
		+	OK, enough writing about writing code; the code itself is much more interesting. Have fun!
		+
		+	<i>Source: [https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml{{!}}Google C++ Style Guide]</i>
		+	}}

← Older revision		Revision as of 05:48, 3 November 2011
Line 8:		Line 8:

	= References =		= References =
		+	* https://secure.wikimedia.org/wikipedia/en/wiki/Indent_style#GNU_style
		+	* https://google-styleguide.googlecode.com/svn/trunk/cppguide.xml

	= Tools =		= Tools =

← Older revision		Revision as of 05:45, 3 November 2011
Line 10:		Line 10:

	= Tools =		= Tools =
		+
		+	* http://universalindent.sourceforge.net/
		+	* http://uncrustify.sourceforge.net/