User:Void Singer/Formating - Revision history

Void Singer: updating from LSL tags to SOURCE tags

2015-01-26T16:45:01Z

updating from LSL tags to SOURCE tags

← Older revision		Revision as of 09:45, 26 January 2015
Line 85:		Line 85:
	\|title=Example		\|title=Example
	\|content=		\|content=
	<~~lsl~~>		<source lang="lsl2">
	///-- this is an example script --///		///-- this is an example script --///
	/*//		/*//
Line 128:		Line 128:
	}		}
	}		}
	</~~lsl~~>		</source>
	:[[User:Void_Singer/Programs#Return_to_Void_Singers_user_page\|Return to top]]		:[[User:Void_Singer/Programs#Return_to_Void_Singers_user_page\|Return to top]]
	}}		}}

Void Singer: article expansion

2010-02-17T01:17:22Z

article expansion

Show changes

Void Singer: /* Coding Practices: Formatting */

2009-04-01T02:28:02Z

Coding Practices: Formatting

← Older revision		Revision as of 19:28, 31 March 2009
Line 2:		Line 2:
	== Coding Practices: Formatting ==		== Coding Practices: Formatting ==
	<div style="padding: 0.5em">		<div style="padding: 0.5em">
	this is a listing of how I generally format code, for readability and self documentation, not everyone likes it, but if you use something and stick with it, others will thank you, and you'll thank yourself later when you look at it and your eyes want to glaze over thinking "WTF was I doing?" You ~~definately~~ don't have to format yours the same way. This is just here to share.		this is a listing of how I generally format code, for readability and self documentation, not everyone likes it, but if you use something and stick with it, others will thank you, and you'll thank yourself later when you look at it and your eyes want to glaze over thinking "WTF was I doing?" You definitely don't have to format yours the same way. This is just here to share.
	#variables:		#variables:
	#* all user local variables are prefixed with "v" (for variable) [to quickly Id variables]		#* all user local variables are prefixed with "v" (for variable) [to quickly Id variables]
Line 10:		Line 10:
	#* all user defined functions prefixed "u" and 3 letter return type -eg uFunctionName [to Id functions and return types]		#* all user defined functions prefixed "u" and 3 letter return type -eg uFunctionName [to Id functions and return types]
	#* All Globals are prefixed with "g" [to spot globals]		#* All Globals are prefixed with "g" [to spot globals]
	#* User Functions, User States, and variables use CamelBack style (~~capitized~~ words, no spaces/underscores)		#* User Functions, User States, and variables use CamelBack style (capitalized words, no spaces/underscores)
	#* All Constants are prefixed "c", use all Caps, and underscores -eg cSTR_TITLE [spot non-LSL constants, avoid conflicts with new LSL constants]		#* All Constants are prefixed "c", use all Caps, and underscores -eg cSTR_TITLE [spot non-LSL constants, avoid conflicts with new LSL constants]
	#* Bitmasks and booleans are given type "vBit" and "vBoo" [to know how they are being used]		#* Bitmasks and booleans are given type "vBit" and "vBoo" [to know how they are being used]
	#* Vectors describing Size, Position, or Color are given as vSiz, vPos, & vCol, respectively		#* Vectors describing Size, Position, Degrees, or Color are given as vSiz, vPos, vDeg, & vCol, respectively
	~~#Comments: [use lots of them to remember/see what code is trying to do]~~
	~~#* Sections/Headers: "//--// text //--//"~~
	~~#* Code: " //-- the line below does X" (note the extra space indent)~~
	~~#* Edit/Notes: " //-- the line to the left is editable or could use changes"~~
	#Braces, brackets, and parentheses:		#Braces, brackets, and parentheses:
	#* Functions: space away from the container -eg. llRound( vIntNumber ); [makes it different from grouping]		#* Functions: space away from the container -eg. llRound( vIntNumber ); [makes it different from grouping]
Line 24:		Line 20:
	#* Events: follow function rules -eg. touch_start( integer vIntTouches ){		#* Events: follow function rules -eg. touch_start( integer vIntTouches ){
	#* If/Loop/while: follows grouping rules with a space before group -eg if (TRUE){		#* If/Loop/while: follows grouping rules with a space before group -eg if (TRUE){
	#* All control structures, states, user functions: "{" goes on the same line as the calling body, "}" after the last entry, and are ALWAYS used [readability, debugging, code insertion ~~safty~~]		#* Variables in if/loop/while tests go to the right of the comparison operator -eg if (FALSE == vBooVariable) [reduces assignment errors]
			#* All control structures, states, user functions: "{" goes on the same line as the calling body, "}" after the last entry, and are ALWAYS used [readability, debugging, code insertion safety]
			#Comments: [use lots of them to remember/see what code is trying to do]
			#* Sections/Headers: "//--// text //--//"
			#* Code: " //-- the line below does X" (note the extra space indent)
			#* Edit/Notes: " //-- the line to the left is editable or could use changes"
	#WhiteSpace:		#WhiteSpace:
	#* blank line between event [groups event code]		#* blank line between event [groups event code]
	#* blank line between sections of code doing different things [groups similar actions]		#* blank line between sections of code doing different things [groups similar actions]
	#* tabs are set at 2 spaces, [reduce wrapping of nested items]		#* tabs are set at 2 spaces, [reduce wrapping of nested items]
	#* All items inside a control structure, state, or user function are indented one level [~~eaiser~~ to read/debug]		#* All items inside a control structure, state, or user function are indented one level [easier to read/debug]
	#Special Items:		#Special Items:
	#* Bitmasks, Keys, and hexadecimal codes are in uppercase -eg. 0xFFFFFFFF [to see usage, readability]		#* Bitmasks, Keys, and hexadecimal codes are in uppercase -eg. 0xFFFFFFFF [to see usage, readability]
Line 38:		Line 39:
	//--// than to show my formatting //--//		//--// than to show my formatting //--//

	string cSTR_TITLE = "example script:"; //-- ~~something~~ to ~~tell~~ the ~~user later~~		string cSTR_TITLE = "example script:"; //-- the line to the left is a constant
	integer gIntTotalTouches = 0;		integer gIntTotalTouches = 0;

Line 55:		Line 56:
	llSay( 0,		llSay( 0,
	cSTR_TITLE + " has been touched " //-- this is an example of my		cSTR_TITLE + " has been touched " //-- this is an example of my
	+ (string)(++~~vgIntTotalTouches~~) //-- function wrapping, lines start		+ (string)(++vIntTouchCount) //-- function wrapping, lines start
	+ " times" ); //-- with math/join symbols when avalable		+ " times" ); //-- with math/join symbols when avalable
	}while (--vIntTouchCount);		}while (--vIntTouchCount);
Line 69:		Line 70:
	state sReset{		state sReset{
	state_entry(){		state_entry(){
	llSay( 0, "New Owner " + uStrKey2Name( llGetOwner() ) + " detected; ~~reseting~~" );		llSay( 0, "New Owner " + uStrKey2Name( llGetOwner() ) + " detected; resetting" );
	llResetScript();		llResetScript();
	}		}

Void Singer: /* Coding Practices: Formatting */

2009-03-31T23:57:34Z

Coding Practices: Formatting

← Older revision		Revision as of 16:57, 31 March 2009
Line 2:		Line 2:
	== Coding Practices: Formatting ==		== Coding Practices: Formatting ==
	<div style="padding: 0.5em">		<div style="padding: 0.5em">
	this is a listing of how I format code, for readability and self documentation, not everyone likes it, but if you use something and stick with it, others will thank you, and you'll thank yourself later when you look at it and your eyes want to glaze over thinking "WTF was I doing?"		this is a listing of how I generally format code, for readability and self documentation, not everyone likes it, but if you use something and stick with it, others will thank you, and you'll thank yourself later when you look at it and your eyes want to glaze over thinking "WTF was I doing?" You definately don't have to format yours the same way. This is just here to share.
	#variables:		#variables:
	#* all user variables are prefixed with "v" (for variable) [~~so we can~~ quickly Id variables]		#* all user local variables are prefixed with "v" (for variable) [to quickly Id variables]
	#* all variables have their type included in 3 letters (eg. vStrData) [so we know the type, saves debugging typcast problems]		#* all variables have their type included in 3 letters (eg. vStrData) [so I know the type, saves debugging typcast problems]
	#* all variables denote what they are for (eg. key vKeyOwner = llGetOwner();) [saves on comments, makes it esay to know what we're doing]		#* all variables denote what they are for (eg. key vKeyOwner = llGetOwner();) [saves on comments, makes it esay to know what I'm doing]
	#* all States prefixed "vs" -eg ~~vsStateName~~ [~~so we can~~ id states]		#* all States prefixed "s" -eg sStateName [to id states]
	#* all user defined functions prefixed "vf" and return type -eg ~~vfFunctionName~~ [~~so we can~~ Id functions and ~~their~~ return types]		#* all user defined functions prefixed "u" and 3 letter return type -eg uFunctionName [to Id functions and return types]
	#* All Globals are prefixed with "vg" ~~(for variable-global)~~ [~~makes it easy~~ to spot globals]		#* All Globals are prefixed with "g" [to spot globals]
	#* All Constants are prefixed "c" and ~~placed in all caps to distinguish from ll~~ -eg cSTR_TITLE [~~easier to~~ spot non ll constants, ~~and~~ avoid ~~possible~~ conflicts with new ll constants]		#* User Functions, User States, and variables use CamelBack style (capitized words, no spaces/underscores)
	#* Bitmasks and booleans are given type "vBit" and "vBoo" [~~so we~~ know how they are being used]		#* All Constants are prefixed "c", use all Caps, and underscores -eg cSTR_TITLE [spot non-LSL constants, avoid conflicts with new LSL constants]
			#* Bitmasks and booleans are given type "vBit" and "vBoo" [to know how they are being used]
	#* Vectors describing Size, Position, or Color are given as vSiz, vPos, & vCol, respectively		#* Vectors describing Size, Position, or Color are given as vSiz, vPos, & vCol, respectively
	#Comments: [use lots of them to ~~help us~~ remember/see what code is trying to do]		#Comments: [use lots of them to remember/see what code is trying to do]
	#*Sections/Headers: "//--// text //--//"		#* Sections/Headers: "//--// text //--//"
	#*Code: " //-- the line below does X" (note the extra space indent		#* Code: " //-- the line below does X" (note the extra space indent)
	#*Edit/Notes: " //-- the line to the left is editable or could use changes"		#* Edit/Notes: " //-- the line to the left is editable or could use changes"
	#~~Brackets/Whitespace~~:		#Braces, brackets, and parentheses:
	#*Functions: space away from the container -eg. llRound( vIntNumber ); [makes it different from grouping]		#* Functions: space away from the container -eg. llRound( vIntNumber ); [makes it different from grouping]
	#*math: always separate math -eg 2 + 2, exception increments --x, ++x [easier to read/debug]		#* math: always separate math -eg 2 + 2, exception increments --x, ++x [easier to read/debug, prevent unary operator errors]
	#Grouping: do not space inside, or out -eg. ((vIntNumber + 2) 5) [makes it different from functions]		#* Grouping: do not space inside, or out -eg. ((vIntNumber + 2) * 5) [makes it different from functions]
	#*Events: follow function rules ~~+ {~~ -eg. touch_start( integer vIntTouches ){		#* Events: follow function rules -eg. touch_start( integer vIntTouches ){
	#*If/Loop: follows grouping rules with a space before group~~, and trailing {~~ -eg if (TRUE){		#* If/Loop/while: follows grouping rules with a space before group -eg if (TRUE){
	#*~~loops, if/else, events~~, states, functions: "{" goes on the same line as the calling body, "}" after the last entry, and are ALWAYS used ~~(even where optional)~~ [~~for~~ readability & debugging]		#* All control structures, states, user functions: "{" goes on the same line as the calling body, "}" after the last entry, and are ALWAYS used [readability, debugging, code insertion safty]
	~~Note:~~		#WhiteSpace:
	~~Due to disagreement about placing "{" on the same line as the originating structure, they~~		#* blank line between event [groups event code]
	~~will be on the line following the structure for WIKI function examples... it's a matter of~~		#* blank line between sections of code doing different things [groups similar actions]
	~~personal taste and practice for me, so not a big deal =)~~		#* tabs are set at 2 spaces, [reduce wrapping of nested items]
	#~~General~~ WhiteSpace:		#* All items inside a control structure, state, or user function are indented one level [eaiser to read/debug]
	#*blank line between event [~~easier to read~~]		#Special Items:
	#*blank line between sections of code doing different things [groups ~~like~~ actions]		#* Bitmasks, Keys, and hexadecimal codes are in uppercase -eg. 0xFFFFFFFF [to see usage, readability]
	#*tabs are 2 spaces, to reduce wrapping ~~for~~ nested items~~. any~~ items inside a ~~loop, if/else, event~~, state, or function ~~recieves a tab~~ [~~saves wrapping,~~ eaiser to read/debug]		#* Long tests/function calls: wrap each variable/container to the next line with level spacing -eg see below [readability, cleaner than built in wrapping]
	#Special ~~Cases~~:		<lsl>
	#* Bitmasks ~~given as numbers~~ are in uppercase ~~hex~~ -eg. 0xFFFFFFFF [~~easier~~ to see usage]
	#* Long tests/function calls: wrap each variable/container to the next line with level spacing -eg see below [~~easier to read~~, ~~less sloppy~~ than built in wrapping]
	<~~pre~~>
	//--// this is an example script //--//		//--// this is an example script //--//
	//--// it has no real purpose other //--//		//--// it has no real purpose other //--//
	//--// than to show my formatting //--//		//--// than to show my formatting //--//

	string cSTR_TITLE = "example script" //-- something to tell the user later		string cSTR_TITLE = "example script:"; //-- something to tell the user later
	integer ~~vgIntTotalTouches~~ = 0;		integer gIntTotalTouches = 0;

	string ~~vfStrFunctionExample~~( key ~~vKeyOwner~~ ){		string uStrKey2Name( key vKeyAvatar ){
	return llKey2Name( ~~vKeyOwner~~ );		return llKey2Name( vKeyAvatar );
	}		}

	default{		default{
	state_entry(){		state_entry(){
	llOwnerSay( "Hi, " + ~~vfStrFunctionExample~~( llGetOwner() ) );		llOwnerSay( "Hi, " + uStrKey2Name( llGetOwner() ) );
	}		}

Line 56:		Line 54:
	//-- below is the example of wrapping functions parameters		//-- below is the example of wrapping functions parameters
	llSay( 0,		llSay( 0,
	cSTR_TITLE + " has been touched " //-- this is an example of		cSTR_TITLE + " has been touched " //-- this is an example of my
	+ (string)(++vgIntTotalTouches) //-- ~~string~~ wrapping, ~~always~~		+ (string)(++vgIntTotalTouches) //-- function wrapping, lines start
	+ " times" ); //-- ~~has + in the front~~		+ " times" ); //-- with math/join symbols when avalable
	}while (--vIntTouchCount ~~> -1~~);		}while (--vIntTouchCount);
	}		}

	changed( integer vBitChanged ){		changed( integer vBitChanged ){
	if (vBitChanged ~~& CHANGED_OWNER~~){		if (CHANGED_OWNER & vBitChanged){ //-- variables on the right in tests
	state ~~vsReset~~		state sReset;
	}		}
	}		}
	}		}

	state ~~vsReset~~{		state sReset{
	state_entry(){		state_entry(){
	llSay( 0, "New Owner " + ~~vfStrFunctionExample~~( llGetOwner() ) + " detected; reseting" );		llSay( 0, "New Owner " + uStrKey2Name( llGetOwner() ) + " detected; reseting" );
	llResetScript();		llResetScript();
	}		}
	}		}
	</~~pre~~>		</lsl>
	</div></div>		</div></div>

	<div id="box">		<div id="box">

	== Comments ==		== Comments ==
	<div style="padding: 0.5em">		<div style="padding: 0.5em">
	Feel free to leave me a note on my [[User_talk:Void_Singer\|User Talk]] page.		Feel free to leave me a note on my [[User_talk:Void_Singer\|User Talk]] page.
	</div></div>		</div></div>

Void Singer: cleanup

2007-11-26T11:07:42Z

cleanup

← Older revision		Revision as of 04:07, 26 November 2007
Line 1:		Line 1:
	<div id="box">		<div id="box">
			== Coding Practices: Formatting ==
	<div style="padding: 0.5em">		<div style="padding: 0.5em">
	~~== Coding Practices: Formatting ==~~
	this is a listing of how I format code, for readability and self documentation, not everyone likes it, but if you use something and stick with it, others will thank you, and you'll thank yourself later when you look at it and your eyes want to glaze over thinking "WTF was I doing?"		this is a listing of how I format code, for readability and self documentation, not everyone likes it, but if you use something and stick with it, others will thank you, and you'll thank yourself later when you look at it and your eyes want to glaze over thinking "WTF was I doing?"
	#variables:		#variables:
Line 79:		Line 79:

	<div id="box">		<div id="box">
			== Comments ==
	<div style="padding: 0.5em">		<div style="padding: 0.5em">
	~~== Comments ==~~
	Feel free to leave me a note on my [[User_talk:Void_Singer\|User Talk]] page.		Feel free to leave me a note on my [[User_talk:Void_Singer\|User Talk]] page.
	</div></div>		</div></div>

Void Singer: reworking user pages

2007-11-20T12:56:57Z

reworking user pages

New page

<div id="box">
<div style="padding: 0.5em">
== Coding Practices: Formatting ==
this is a listing of how I format code, for readability and self documentation, not everyone likes it, but if you use something and stick with it, others will thank you, and you'll thank yourself later when you look at it and your eyes want to glaze over thinking "WTF was I doing?"
#variables:
#* all user variables are prefixed with "v" (for variable) [so we can quickly Id variables]
#* all variables have their type included in 3 letters (eg. vStrData) [so we know the type, saves debugging typcast problems]
#* all variables denote what they are for (eg. key vKeyOwner = llGetOwner();) [saves on comments, makes it esay to know what we're doing]
#* all States prefixed "vs" -eg vsStateName [so we can id states]
#* all user defined functions prefixed "vf" and return type -eg vfFunctionName [so we can Id functions and their return types]
#* All Globals are prefixed with "vg" (for variable-global) [makes it easy to spot globals]
#* All Constants are prefixed "c" and placed in all caps to distinguish from ll -eg cSTR_TITLE [easier to spot non ll constants, and avoid possible conflicts with new ll constants]
#* Bitmasks and booleans are given type "vBit" and "vBoo" [so we know how they are being used]
#* Vectors describing Size, Position, or Color are given as vSiz, vPos, & vCol, respectively
#Comments: [use lots of them to help us remember/see what code is trying to do]
#*Sections/Headers: "//--// text //--//"
#*Code: " //-- the line below does X" (note the extra space indent
#*Edit/Notes: " //-- the line to the left is editable or could use changes"
#Brackets/Whitespace:
#*Functions: space away from the container -eg. llRound( vIntNumber ); [makes it different from grouping]
#*math: always separate math -eg 2 + 2, exception increments --x, ++x [easier to read/debug]
#*Grouping: do not space inside, or out -eg. ((vIntNumber + 2) * 5) [makes it different from functions]
#*Events: follow function rules + { -eg. touch_start( integer vIntTouches ){
#*If/Loop: follows grouping rules with a space before group, and trailing { -eg if (TRUE){
#*loops, if/else, events, states, functions: "{" goes on the same line as the calling body, "}" after the last entry, and are ALWAYS used (even where optional) [for readability & debugging]
Note:
Due to disagreement about placing "{" on the same line as the originating structure, they
will be on the line following the structure for WIKI function examples... it's a matter of
personal taste and practice for me, so not a big deal =)
#General WhiteSpace:
#*blank line between event [easier to read]
#*blank line between sections of code doing different things [groups like actions]
#*tabs are 2 spaces, to reduce wrapping for nested items. any items inside a loop, if/else, event, state, or function recieves a tab [saves wrapping, eaiser to read/debug]
#Special Cases:
#* Bitmasks given as numbers are in uppercase hex -eg. 0xFFFFFFFF [easier to see usage]
#* Long tests/function calls: wrap each variable/container to the next line with level spacing -eg see below [easier to read, less sloppy than built in wrapping]
<pre>
//--// this is an example script //--//
//--// it has no real purpose other //--//
//--// than to show my formatting //--//

string cSTR_TITLE = "example script" //-- something to tell the user later
integer vgIntTotalTouches = 0;

string vfStrFunctionExample( key vKeyOwner ){
return llKey2Name( vKeyOwner );
}

default{
state_entry(){
llOwnerSay( "Hi, " + vfStrFunctionExample( llGetOwner() ) );
}

touch_start( integer vIntTouchCount ){
do{
//-- below is the example of wrapping functions parameters
llSay( 0,
cSTR_TITLE + " has been touched " //-- this is an example of
+ (string)(++vgIntTotalTouches) //-- string wrapping, always
+ " times" ); //-- has + in the front
}while (--vIntTouchCount > -1);
}

changed( integer vBitChanged ){
if (vBitChanged & CHANGED_OWNER){
state vsReset
}
}
}

state vsReset{
state_entry(){
llSay( 0, "New Owner " + vfStrFunctionExample( llGetOwner() ) + " detected; reseting" );
llResetScript();
}
}
</pre>
</div></div>

<div id="box">
<div style="padding: 0.5em">
== Comments ==
Feel free to leave me a note on my [[User_talk:Void_Singer|User Talk]] page.
</div></div>