Difference between revisions of "comment"
Jump to navigation
Jump to search
(mass edit: removing obsolete </dt> and </dd> tags) |
m (template:command argument fix) |
||
(16 intermediate revisions by 11 users not shown) | |||
Line 9: | Line 9: | ||
| 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]]. |= | + | 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= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | | '''comment''' | + | | '''comment''' commentMsg |SYNTAX= |
− | |p1= | + | |p1= commentMsg: [[String]] - the comment that you'd like to write here |PARAMETER1= |
− | | [[Nothing]] |= | + | | [[Nothing]] |RETURNVALUE= |
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | |x1= script.sqs < | + | |x1= script.sqs <code>[[comment]] "This is a commented line"</code> |EXAMPLE1= |
− | |x2= function.sqf < | + | |x2= function.sqf <code>[[comment]] "This is a commented line";</code> |EXAMPLE2= |
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | | [[Control Structures]] |= | + | | [[Control Structures]] |SEEALSO= |
}} | }} | ||
Line 30: | Line 31: | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<dd class="notedate">Posted on September 12, 2009 - 19:50 | <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 : | <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 | first line | ||
− | seconde line"; | + | seconde line";</code> |
Line 51: | Line 45: | ||
[[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]] | ||
[[Category:Scripting Commands ArmA|COMMENT]] | [[Category:Scripting Commands ArmA|COMMENT]] | ||
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]] | [[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | ||
+ | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
+ | [[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | ||
+ | |||
+ | <!-- 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> | ||
+ | </dl> | ||
+ | <!-- DISCONTINUE Notes --> | ||
+ | |||
+ | <!-- CONTINUE Notes --> | ||
+ | <dl class="command_description"> | ||
+ | <dd class="notedate">Posted on November 4, 2016 - 20:46 (UTC)</dd> | ||
+ | <dt class="note">[[User:Revo|Revo]]</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 --> |
Revision as of 14:35, 7 April 2019
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.
Template:warning
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:
- Uncategorised
Notes
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)
- Revo
- comment can also be used to create comments inside trigger activation fields where // or /*...*/ don't work.
Categories:
- Pages using duplicate arguments in template calls
- Scripting Commands
- Operation Flashpoint: Resistance: Scripting Commands
- Operation Flashpoint: Resistance: New Scripting Commands
- Command Group: Uncategorised
- Introduced with Operation Flashpoint: Resistance version 1.85
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands ArmA
- Command Group: System Commands
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters