comment: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)]]" to "{{GameCategory|arma2|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| ofpr |Game name= | | ofpr |Game name= | ||
| Line 7: | Line 6: | ||
|gr1= Strings |GROUP1= | |gr1= Strings |GROUP1= | ||
| Define a comment. | | Define a comment. | ||
| Line 13: | Line 11: | ||
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.}} |DESCRIPTION= | ||
| '''comment''' commentMsg |SYNTAX= | | '''comment''' commentMsg |SYNTAX= | ||
| Line 20: | Line 17: | ||
| [[Nothing]] |RETURNVALUE= | | [[Nothing]] |RETURNVALUE= | ||
|x1= script.sqs <code>[[comment]] "This is a commented line"</code> |EXAMPLE1= | |x1= script.sqs <code>[[comment]] "This is a commented line"</code> |EXAMPLE1= | ||
|x2= function.sqf <code>[[comment]] "This is a commented line";</code> |EXAMPLE2= | |x2= function.sqf <code>[[comment]] "This is a commented line";</code> |EXAMPLE2= | ||
| [[Control Structures]] |SEEALSO= | | [[Control Structures]] |SEEALSO= | ||
Revision as of 00:25, 17 January 2021
Description
- Description:
- Define a comment.
Mainly used in SQF Syntax, as you're able to introduce comment lines with semicolons in a SQS script.
- 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.
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint: Resistance version 1.85
- Operation Flashpoint: Resistance: New Scripting Commands
- Operation Flashpoint: Resistance: Scripting Commands
- Command Group: Strings
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands