User:Clonkonaut/Style Guidelines - Revision history

Clonkonaut: /* Comments */

2009-10-09T16:11:37Z

Comments

← Older revision		Revision as of 16:11, 9 October 2009
Line 70:		Line 70:
	// Necessary comment:		// Necessary comment:
	// This starts the whole effect, casts particles and stuff		// This starts the whole effect, casts particles and stuff
	CreateObject(~~BAR_~~, 0,0, GetOwner())->foo();		CreateObject(BAR1, 0,0, GetOwner())->foo();

	Especially for German scripters: '''comment in English please!'''		Especially for German scripters: '''comment in English please!'''

Clonkonaut: /* Comments */

2009-10-09T15:19:53Z

Comments

← Older revision		Revision as of 15:19, 9 October 2009
Line 69:		Line 69:

	// Necessary comment:		// Necessary comment:
	// ~~Create helper object that does foo~~		// This starts the whole effect, casts particles and stuff
	CreateObject(BAR_, 0,0, GetOwner())->foo();		CreateObject(BAR_, 0,0, GetOwner())->foo();

Clonkonaut: /* Spaces */

2009-10-09T14:15:50Z

Spaces

← Older revision		Revision as of 14:15, 9 October 2009
Line 36:		Line 36:
	Keywords followed by a space: <tt>if, while, for</tt>		Keywords followed by a space: <tt>if, while, for</tt>

	Commas are followed by a space, function names not. <tt>-></tt>, <tt>->~</tt>, <tt>++</tt> and <tt>--</tt> don't need spaces, other operators do.		Commas are followed by a space, function names not. <tt>-></tt>, <tt>->~</tt>, <tt>++</tt> and <tt>--</tt> don't need spaces, other operators do. <tt>+</tt> and <tt>-</tt> don't need spaces either when used as algebraic signs, otherwise they do.

	var foo = 0;		var foo = 0;

Clonkonaut: /* Scripting policy */

2009-10-09T14:08:09Z

Scripting policy

← Older revision		Revision as of 14:08, 9 October 2009
Line 2:		Line 2:

	Style guideline for coding C4Script in OpenClonk.		Style guideline for coding C4Script in OpenClonk.
	The development is based on exchange of scripts. Therefore it is necessary to define some styling rules, so that other ~~developer~~ can read your code more easily.		The development is based on exchange of scripts. Therefore it is necessary to define some styling rules, so that other developers can read your code more easily.

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

Clonkonaut at 22:21, 8 October 2009

2009-10-08T22:21:42Z

@@ Line 8: / Line 8: @@
 Indent your code with tabs (ASCII 9). Use space (ASCII 32) for all other formatting.
-Example:
+ public func foo()
+ {
-public func foo()
+ 	bar();
+ 	if (1)
-	bar();
-	if (1)
+ 		bar2();
+ 	}
-		bar2();
 === Braces ===
 According to the [http://forum.openclonk.org/topic_show.pl?tid=208 poll] in the forum:
 Braces are on their own line, on the same level of indentation as the structure they belong to. You may add braces around single statements in if statements if the first block or an else block has them.

Clonkonaut: Created page with '== Scripting policy == Style guideline for coding C4Script in OpenClonk. The development is based on exchange of scripts. Therefore it is necessary to define some styling rules,...'

2009-10-08T21:24:25Z

Created page with '== Scripting policy == Style guideline for coding C4Script in OpenClonk. The development is based on exchange of scripts. Therefore it is necessary to define some styling rules,...'

New page

== Scripting policy ==

Style guideline for coding C4Script in OpenClonk.
The development is based on exchange of scripts. Therefore it is necessary to define some styling rules, so that other developer can read your code more easily.

=== Indentation ===

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

Example:

public func foo()
{
bar();
if (1)
{
bar2();
}
}

=== Braces ===

According to the [http://forum.openclonk.org/topic_show.pl?tid=208 poll] in the forum:
Braces are on their own line, on the same level of indentation as the structure they belong to. You may add braces around single statements in if statements if the first block or an else block has them.