Style Guidelines - Revision history

Marky: /* Data Types */

2019-06-17T17:03:03Z

Data Types

← Older revision		Revision as of 17:03, 17 June 2019
Line 158:		Line 158:
	after. This saves some confusion when declaring multiple variables at once.		after. This saves some confusion when declaring multiple variables at once.
	The same goes for references.		The same goes for references.

			Assign variable values in separate lines, because this improves readability. Do not assign variable values and declare other variables of the same type in the same line, because this reduces readability.

	int foo, bar;		int foo, bar;
	char Qux(const char quux);		char Qux(const char quux);
			int a = 1;
			int b = 2;
			int c, d, e;

	==== Functions ====		==== Functions ====

2014-11-23T23:01:20Z

Line endings: Mercurial is history

← Older revision		Revision as of 23:01, 23 November 2014
Line 5:		Line 5:
	=== All-encompassing Guidelines ===		=== All-encompassing Guidelines ===
	==== Line endings ====		==== Line endings ====
	Use a single line feed character (ASCII 10) for line endings~~. Mercurial provides~~		Use a single line feed character (ASCII 10) for line endings.
	~~an extension named ''win32text'' you can use to auto-convert files from your~~
	~~OS's native format to single LF and vice-versa~~.

	==== Indentation ====		==== Indentation ====

2014-11-23T23:00:22Z

← Older revision		Revision as of 23:00, 23 November 2014
Line 85:		Line 85:
	Every source file begins with a copyright header. If you make significant		Every source file begins with a copyright header. If you make significant
	changes to the code, you may (but are not required to) add your name to the		changes to the code, you may (but are not required to) add your name to the
	list of copyright holders. If you choose to add yourself, use your real name,		list of copyright holders in <tt>COPYING</tt>. If you choose to add yourself, use your real name,
	not a nickname. Legally recognized pseudonyms are accepted, as are names of		not a nickname. Legally recognized pseudonyms are accepted, as are names of
	legal entities~~. If you don't want to add yourself, you may add the catch-all~~		legal entities.
	~~copyright attribution phrase, if it does not already exist~~.

	/*		/*
	* OpenClonk, http://www.openclonk.org		* OpenClonk, http://www.openclonk.org
	*		*
	* Copyright (c) ~~2000~~-~~2009 John Doe~~		* Copyright (c) 2009-2014, The OpenClonk Team and contributors
	* Copyright (c) 2005 Jane Q. Public
	*
	* Portions might be copyrighted by other authors who have contributed
	* to OpenClonk.
	*		*
	* Other legalese goes here, but has been omitted for brevity. See an		* Other legalese goes here, but has been omitted for brevity. See an

2013-11-11T14:52:19Z

Data Types: Win32 typedefs are fine when interfacing with WinAPI

← Older revision		Revision as of 14:52, 11 November 2013
Line 153:		Line 153:
	==== Data Types ====		==== Data Types ====
	Do not use the Win32 style integer declarations <tt>DWORD</tt> and		Do not use the Win32 style integer declarations <tt>DWORD</tt> and
	<tt>BOOL</tt>. If you need a guarantee about the size of your variables, use		<tt>BOOL</tt> except when interfacing with the Windows API. If you need a guarantee about the size of your variables, use
	the C99 types <tt>int''XX''_t</tt> and <tt>uint''XX''_t</tt>. If you don't		the C99 types <tt>int''XX''_t</tt> and <tt>uint''XX''_t</tt>. If you don't
	need that guarantee, use <tt>int</tt>. If you need a variable that is large		need that guarantee, use <tt>int</tt>. If you need a variable that is large

2010-03-26T19:26:11Z

Spaces for operators

← Older revision		Revision as of 19:26, 26 March 2010
Line 31:		Line 31:
	Function names are not followed by space. Commas are. No space follows opening		Function names are not followed by space. Commas are. No space follows opening
	brackets ("[") or parentheses ("("). Also no space preceeds closing brackets		brackets ("[") or parentheses ("("). Also no space preceeds closing brackets
	("]") or parentheses (")"). ~~Unary~~ operators do not require spaces. ~~Binary~~		("]") or parentheses (")"), or commas. "::", "->", "." and unary operators do not
	operators ~~(except for the member access operators "." and "->")~~ do.		require spaces. Other binary operators do.

	Keywords (<tt>while</tt>, <tt>for</tt> etc.) are followed by a space.		Keywords (<tt>while</tt>, <tt>for</tt> etc.) are followed by a space.

2010-03-26T19:19:29Z

. and -> aren't enclosed by spaces

← Older revision		Revision as of 19:19, 26 March 2010
Line 32:		Line 32:
	brackets ("[") or parentheses ("("). Also no space preceeds closing brackets		brackets ("[") or parentheses ("("). Also no space preceeds closing brackets
	("]") or parentheses (")"). Unary operators do not require spaces. Binary		("]") or parentheses (")"). Unary operators do not require spaces. Binary
	operators do.		operators (except for the member access operators "." and "->") do.

	Keywords (<tt>while</tt>, <tt>for</tt> etc.) are followed by a space.		Keywords (<tt>while</tt>, <tt>for</tt> etc.) are followed by a space.

2009-11-08T14:41:51Z

Missing "you" added

← Older revision		Revision as of 14:41, 8 November 2009
Line 139:		Line 139:
	a <tt>template</tt>.		a <tt>template</tt>.

	If, despite of the above, still need to write a macro, use an all-uppercase		If, despite of the above, you still need to write a macro, use an all-uppercase
	name. If your macro contains a compound statement, enclose it in a <tt>do</tt>		name. If your macro contains a compound statement, enclose it in a <tt>do</tt>
	loop to allow its use in <tt>if</tt> statements. A terminating semicolon		loop to allow its use in <tt>if</tt> statements. A terminating semicolon

2009-10-24T16:56:30Z

← Older revision	Revision as of 16:56, 24 October 2009
(No difference)

2009-10-14T16:24:12Z

Line endings

← Older revision		Revision as of 16:24, 14 October 2009
Line 4:		Line 4:

	=== All-encompassing Guidelines ===		=== All-encompassing Guidelines ===
			==== Line endings ====
			Use a single line feed character (ASCII 10) for line endings. Mercurial provides
			an extension named ''win32text'' you can use to auto-convert files from your
			OS's native format to single LF and vice-versa.

	==== Indentation ====		==== Indentation ====
	Indent your code with tabs (ASCII 9). Use space (ASCII 32) for all other		Indent your code with tabs (ASCII 9). Use space (ASCII 32) for all other

2009-10-13T20:34:00Z

Preprocessor Macros: Remove aligning of macro line continuations, since tab width may vary

← Older revision		Revision as of 20:34, 13 October 2009
Line 138:		Line 138:
	loop to allow its use in <tt>if</tt> statements. A terminating semicolon		loop to allow its use in <tt>if</tt> statements. A terminating semicolon
	should be provided at the place of invocation. This makes parsing the source		should be provided at the place of invocation. This makes parsing the source
	easier for pretty-printers and editors~~. If your macro spans multiple lines,~~		easier for pretty-printers and editors. Consider undefining your macro when
	~~align the backslashes~~. Consider undefining your macro when you are done using		you are done using it.
	it.

	#define FOO(a, b) do { \		#define FOO(a, b) do { \
	bar += (a); \		bar += (a); \
	bar /= (b); \		bar /= (b); \
	} while(0)		} while(0)