CodingStandards - Revision history

Talad: /* Automatic Code Formatter tool */

2012-05-30T19:50:33Z

Automatic Code Formatter tool

← Older revision		Revision as of 19:50, 30 May 2012
Line 6:		Line 6:
	http://astyle.sourceforge.net/		http://astyle.sourceforge.net/

	with the following options: --style=allman --align-pointer=type --indent-switches --unpad-paren		with the following options: --style=allman --align-reference=name --align-pointer=type --indent-switches --unpad-paren

	To use it in msvc2010 use [[astyle msvc\|this short guide]].		To use it in msvc2010 use [[astyle msvc\|this short guide]].

2012-05-30T19:32:56Z

Automatic Code Formatter tool

← Older revision		Revision as of 19:32, 30 May 2012
Line 6:		Line 6:
	http://astyle.sourceforge.net/		http://astyle.sourceforge.net/

	with the following options: --style=allman --indent-switches --unpad-paren		with the following options: --style=allman --align-pointer=type --indent-switches --unpad-paren

	To use it in msvc2010 use [[astyle msvc\|this short guide]].		To use it in msvc2010 use [[astyle msvc\|this short guide]].

2012-05-30T13:24:40Z

← Older revision		Revision as of 13:24, 30 May 2012
Line 1:		Line 1:

			== Automatic Code Formatter tool ==

			To be compliant with the guidelines below a good start is to use:

			http://astyle.sourceforge.net/

			with the following options: --style=allman --indent-switches --unpad-paren

			To use it in msvc2010 use [[astyle msvc\|this short guide]].

	== Indentation/Tabs/Space Policy ==		== Indentation/Tabs/Space Policy ==

2011-05-13T17:59:09Z

Braces {} Policy

← Older revision		Revision as of 17:59, 13 May 2011
Line 27:		Line 27:
	Place brace under and inline with keywords:		Place brace under and inline with keywords:

	if(condition) if(condition) ~~while~~(condition)		while(condition)
	~~{ {~~ {		{
	~~... ...~~ ...		...
	~~} }~~ }		}
	else
	{		if(condition)
	...		{
	}		...
			}

			if(condition)
			{
			...
			}
			else
			{
			...
			}

	== Parentheses () Policy ==		== Parentheses () Policy ==

2011-05-13T17:52:42Z

Braces {} Policy

← Older revision		Revision as of 17:52, 13 May 2011
Line 27:		Line 27:
	Place brace under and inline with keywords:		Place brace under and inline with keywords:

	if(condition) while(condition)		if(condition) if(condition) while(condition)
	{ {		{ { {
	... ...		... ... ...
	} }		} } }
			else
			{
			...
			}

	== Parentheses () Policy ==		== Parentheses () Policy ==

2011-02-13T18:42:31Z

Documentation

← Older revision		Revision as of 18:42, 13 February 2011
Line 158:		Line 158:

	== Documentation ==		== Documentation ==
	~~Code use doxcygen~~ style ~~comments~~. JAVADOC_AUTOBRIEF ~~style is allowed~~.		Jave documentation style is used. doxcygen with the JAVADOC_AUTOBRIEF will generate correct reports.

	/** This is a brief description that ends with a dot. Detail		/** This is a brief description that ends with a dot. Detail

2011-02-13T18:04:34Z

Documentation

← Older revision		Revision as of 18:04, 13 February 2011
Line 163:		Line 163:
	* description follows.		* description follows.
	*/		*/

			int var; ///< Description of variable.

	[[Category:Engine documents]]		[[Category:Engine documents]]

2011-02-13T17:49:14Z

Documentation

← Older revision		Revision as of 17:49, 13 February 2011
Line 158:		Line 158:

	== Documentation ==		== Documentation ==
			Code use doxcygen style comments. JAVADOC_AUTOBRIEF style is allowed.

			/** This is a brief description that ends with a dot. Detail
			* description follows.
			*/

	[[Category:Engine documents]]		[[Category:Engine documents]]

2011-02-13T17:44:15Z

Header Template

2010-12-12T10:32:46Z

Parentheses() Policy

← Older revision		Revision as of 10:32, 12 December 2010
Line 32:		Line 32:
	} }		} }

	== Parentheses() Policy ==		== Parentheses () Policy ==

	* Don't put a space after reserved words like if [eg: if() not if ()]		* Don't put a space after reserved words like if [eg: if() not if ()]