Difference between revisions of "comment"
Jump to navigation
Jump to search
m (Changed version) |
Lou Montana (talk | contribs) m (Text replacement - " {2,}\}\}" to " }}") |
||
(58 intermediate revisions by 23 users not shown) | |||
Line 1: | Line 1: | ||
− | {{Command | + | {{Command |
− | |||
− | | ofpr | + | | ofpr |
− | |1.85 | + | |1.85 |
− | |||
− | | | + | |gr1= Strings |
− | |||
− | | | + | | 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> |
+ | {{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.}} | ||
− | | [[Nothing]] | + | | '''comment''' commentMsg |
− | + | ||
+ | |p1= commentMsg: [[String]] - the comment that you'd like to write here | ||
+ | |||
+ | | [[Nothing]] | ||
− | |x1= < | + | |x1= script.sqs <code>[[comment]] "This is a commented line"</code> |
− | + | |x2= function.sqf <code>[[comment]] "This is a commented line";</code> | |
− | |||
− | | | ||
+ | | [[Control Structures]] | ||
}} | }} | ||
− | |||
<dl class="command_description"> | <dl class="command_description"> | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
+ | |||
+ | <dd class="notedate">Posted on September 12, 2009 - 19:50 | ||
+ | <dt class="note">[[User:Tom_48_97|Tom_48_97]]<dd class="note">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 : | ||
+ | <code>[[comment]] " | ||
+ | first line | ||
+ | seconde line";</code> | ||
+ | |||
<!-- Note Section END --> | <!-- Note Section END --> | ||
</dl> | </dl> | ||
− | |||
[[Category:Scripting Commands|COMMENT]] | [[Category:Scripting Commands|COMMENT]] | ||
+ | [[Category:Scripting Commands OFP 1.99|COMMENT]] | ||
[[Category:Scripting Commands OFP 1.96|COMMENT]] | [[Category:Scripting Commands OFP 1.96|COMMENT]] | ||
− | [[ | + | {{GameCategory|arma1|Scripting Commands}} |
+ | {{GameCategory|arma2|Scripting Commands}} | ||
+ | {{GameCategory|arma3|Scripting Commands}} | ||
+ | {{GameCategory|tkoh|Scripting Commands}} | ||
+ | |||
+ | <!-- CONTINUE Notes --> | ||
+ | <dl class="command_description"> | ||
+ | <dd class="notedate">Posted on November 4, 2016 - 16:17 (UTC)</dd> | ||
+ | <dt class="note">[[User:Tofof|Tofof]]</dt> | ||
+ | <dd class="note"> | ||
+ | |||
+ | If a file is loaded with [[preprocessFile]], [[execVM]] or [[spawn]] (but not [[loadFile]]), you may also define C-like comments using <tt>// ...</tt> and <tt>/*...*/</tt>. | ||
+ | |||
+ | </dd> | ||
+ | |||
+ | <dd class="notedate">Posted on November 4, 2016 - 20:46 (UTC)</dd> | ||
+ | <dt class="note">[[User:R3vo|R3vo]]</dt> | ||
+ | <dd class="note"> | ||
+ | '''comment''' can also be used to create comments inside trigger activation fields where <tt>//</tt> or <tt>/*...*/</tt> don't work. | ||
+ | </dd> | ||
+ | </dl> | ||
+ | <!-- DISCONTINUE Notes --> |
Latest revision as of 23:10, 18 January 2021
Hover & click on the images for descriptions
Description
- Description:
-
Define a comment.
Mainly used in SQF Syntax, as you're able to introduce comment lines with semicolons in a SQS script.
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
- Groups:
- Strings
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";
- 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
- Operation Flashpoint: Resistance: Scripting Commands
- Operation Flashpoint: Resistance: New Scripting Commands
- Command Group: Strings
- Introduced with Operation Flashpoint: Resistance version 1.85
- 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