Comments - Revision history

Eliot: Correct a wikipedia link

2010-05-07T04:57:49Z

Correct a wikipedia link

00zX: added info on javadoc, bit more explaination and eg of /* multico */

2010-04-22T12:41:51Z

added info on javadoc, bit more explaination and eg of ‎multico

Eliot at 03:41, 22 April 2010

2010-04-22T03:41:54Z

Wormbo: Reverted edits by ErortRclib (Talk); changed back to last version by Azrael

2008-12-05T21:37:43Z

Reverted edits by ErortRclib (Talk); changed back to last version by Azrael

ErortRclib: moneltoubo

2008-12-05T21:13:57Z

moneltoubo

Azrael: Added some basic content.

2008-05-05T12:00:15Z

Added some basic content.

New page

'''Comments''' are a way of inserting text into [[UnrealScript]] code to remind yourself of what the code is doing, or to give a summary of the code file. Comments will be ignored by the compiler, so they can also be used to temporarily 'disable' a line of text.

Anything on a line after the special comment symbol '''//''' is a comment. For example, many official Unreal Tournament files have headers such as this:

<uscript>//=============================================================================
// A sticky note. Level designers can place these in the level and then
// view them as a batch in the error/warnings window.
//=============================================================================
class Note extends Actor
placeable
native;

#exec Texture Import File=Textures\Note.pcx Name=S_Note Mips=Off MASKED=1

var() string Text;
</uscript>

To disable a line of text, simple insert the // before it, like this:
<uscript>simulated function ShaderAction( Shader sh )
{
//log("ShaderAction " $ sh );

switch( MatTriggerAction )
{
case MTA_SwapShaderSpecular:
sh.Specular = SwapMaterialA;
break;
}

}</uscript>

@@ Line 17: / Line 17: @@
 </uscript>
-Because the [[UnrealScript]] language commenting style is very similar to other programming languages commenting styles, the following link might be useful
+Because the [[UnrealScript]] language commenting style is very similar to other programming languages commenting styles, the following link might be useful [[wp:Comment_(computer_programming)]].
-<br>
-[http://en.wikipedia.org/wiki/Comment_(computer_programming) Wikipedia Comment].
 Most of the core functionality is documented by Epic using the [[wp:Javadoc]] style of commenting files, you can however comment in any fashion you like, these are simply commenting guidelines which have become a standard that people use. It allows unified documentation of source across many languages, in this case c-type languages. As an example of an alternative one might use is [[wp:C_Sharp_(programming_language)#XML_documentation_system|C Sharp XML comments]] which is similar to javadocs but instead uses xml.

@@ Line 20: / Line 20: @@
 <br>
 [http://en.wikipedia.org/wiki/Comment_(computer_programming) Wikipedia Comment].
 {{navbox unrealscript}}

← Older revision		Revision as of 21:37, 5 December 2008
Line 1:		Line 1:
−	~~getlav~~
	'''Comments''' are a way of inserting text into [[UnrealScript]] code to remind yourself of what the code is doing, or to give a summary of the code file. Comments will be ignored by the compiler, so they can also be used to temporarily 'disable' a line of text.		'''Comments''' are a way of inserting text into [[UnrealScript]] code to remind yourself of what the code is doing, or to give a summary of the code file. Comments will be ignored by the compiler, so they can also be used to temporarily 'disable' a line of text.

← Older revision		Revision as of 21:13, 5 December 2008
Line 1:		Line 1:
		+	getlav
	'''Comments''' are a way of inserting text into [[UnrealScript]] code to remind yourself of what the code is doing, or to give a summary of the code file. Comments will be ignored by the compiler, so they can also be used to temporarily 'disable' a line of text.		'''Comments''' are a way of inserting text into [[UnrealScript]] code to remind yourself of what the code is doing, or to give a summary of the code file. Comments will be ignored by the compiler, so they can also be used to temporarily 'disable' a line of text.

@@ Line 1: / Line 1: @@
 '''Comments''' are a way of inserting text into [[UnrealScript]] code to remind yourself of what the code is doing, or to give a summary of the code file. Comments will be ignored by the compiler, so they can also be used to temporarily 'disable' a line of text.
-Anything on a line after the special comment symbol '''//''' is a comment. For example, many official Unreal Tournament files have headers such as this:
+[[UnrealScript]] supports two kind of comments a single comment and a multiple line comment.
+<br>
-<uscript>//=============================================================================
+single line comments are used like this
-// A sticky note.  Level designers can place these in the level and then
+<uscript>
-// view them as a batch in the error/warnings window.
+// The commented declaration would also make the compiler ignore the declaration therefor it can be useful to disable declarations
-//=============================================================================
+// for various reasons such as testing and debugging.
-class Note extends Actor
+//var int TestVar;
-	placeable
+</uscript>
-	native;
+and multiple line comments are used like this.
+<uscript>
-#exec Texture Import File=Textures\Note.pcx  Name=S_Note Mips=Off MASKED=1
+/**
+  * NOTE: Never change the value of this variable to -1! the class functions always expect it to be a positive-only value!.
-var() string Text;
+ */
 </uscript>
-To disable a line of text, simple insert the // before it, like this:
+Because the [[UnrealScript]] language commenting style is very similar to other programming languages commenting styles, the following link might be useful
-<uscript>simulated function ShaderAction( Shader sh )
+<br>
+[http://en.wikipedia.org/wiki/Comment_(computer_programming) Wikipedia Comment].
-	//log("ShaderAction " $ sh );
-−
-	switch( MatTriggerAction )
-−
-		case MTA_SwapShaderSpecular:
-			sh.Specular = SwapMaterialA;
-			break;
-−
-}</uscript>
+{{navbox unrealscript}}