comment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofpr |Game name=
| ofpr


|1.85|Game version=
|1.85


|gr1= Strings |GROUP1=
|gr1= Strings


| Define a comment.  
| Define a comment.  


Mainly used in [[SQF_syntax|SQF Syntax]], as you're able to introduce comment lines with semicolons in a [[sqs syntax|SQS script]].<br>
Mainly used in [[SQF_syntax|SQF Syntax]], as you're able to introduce comment lines with semicolons in a [[sqs syntax|SQS script]].<br>
{{Warning|This command is evaluated during execution, and as such is infinitely slower than other SQF comment methods (//comment or /*comment*/; which do not exist at runtime). See [[SQF_syntax|SQF Syntax]] for additional documentation on comments.}} |DESCRIPTION=
{{Warning|This command is evaluated during execution, and as such is infinitely slower than other SQF comment methods (//comment or /*comment*/; which do not exist at runtime). See [[SQF_syntax|SQF Syntax]] for additional documentation on comments.}}


| '''comment''' commentMsg |SYNTAX=
| '''comment''' commentMsg


|p1= commentMsg: [[String]] - the comment that you'd like to write here |PARAMETER1=
|p1= commentMsg: [[String]] - the comment that you'd like to write here


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]
   
   
|x1= script.sqs <code>[[comment]] "This is a commented line"</code> |EXAMPLE1=
|x1= script.sqs <code>[[comment]] "This is a commented line"</code>
|x2= function.sqf <code>[[comment]] "This is a commented line";</code> |EXAMPLE2=
|x2= function.sqf <code>[[comment]] "This is a commented line";</code>


| [[Control Structures]] |SEEALSO=
| [[Control Structures]]


}}
}}

Revision as of 00:11, 18 January 2021

ofpr version.gif1.85
Hover & click on the images for description

Description

Description:
Define a comment. Mainly used in SQF Syntax, as you're able to introduce comment lines with semicolons in a SQS script.
⚠
This command is evaluated during execution, and as such is infinitely slower than other SQF comment methods (//comment or /*comment*/; which do not exist at runtime). See SQF Syntax for additional documentation on comments.
Groups:
Strings

Syntax

Syntax:
comment commentMsg
Parameters:
commentMsg: String - the comment that you'd like to write here
Return Value:
Nothing

Examples

Example 1:
script.sqs comment "This is a commented line"
Example 2:
function.sqf comment "This is a commented line";

Additional Information

See also:
Control Structures

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Posted on September 12, 2009 - 19:50
Tom_48_97
Like ArmA, you can't use brackets to make a multi-lines comment. But, in a sqf file, you can make a comment as follow : comment " first line seconde line";

Bottom Section

Posted on November 4, 2016 - 16:17 (UTC)
Tofof
If a file is loaded with preprocessFile, execVM or spawn (but not loadFile), you may also define C-like comments using // ... and /*...*/.
Posted on November 4, 2016 - 20:46 (UTC)
R3vo
comment can also be used to create comments inside trigger activation fields where // or /*...*/ don't work.
Retrieved from "https://community.bistudio.com/wiki?title=comment&oldid=204085"