From Unreal Wiki, The Unreal Engine Documentation Site
Jump to navigation Jump to search

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.

UnrealScript supports two kind of comments a single comment and a multiple line comment.
single line comments are used like this <uscript> // 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. //var int TestVar; </uscript> and multiple line comments are used like this. <uscript> /**

* NOTE: Never change the value of this variable to -1! the class functions always expect it to be a positive-only value!.

var int TestVar; </uscript>

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).

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 C Sharp XML comments which is similar to javadocs but instead uses xml.

Acouple of notes is that multi line comments typically go as such: <uscript>/* anything in here is a comment

  • /</uscript>

with no following *'s <uscript>/** this is useful technical information

  • /</uscript>

is a common style used for function definition commentary. <uscript>/// single line useful information</uscript> The triple '/' is also used some in place of the double '/', in unrealscript however most of the useful single line commentary is documented using multi line comments as shown in the first example.