Difference between revisions of "comment"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
+
{{RV|type=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=
+
{{Feature|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=
 
  
 +
|seealso= [[Control Structures]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
 
<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</dd>
 
<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]] "
 
<code>[[comment]] "
Line 44: Line 37:
 
</dl>
 
</dl>
  
<h3 style="display:none">Bottom Section</h3>
 
  
[[Category:Scripting Commands|COMMENT]]
+
 
 
[[Category:Scripting Commands OFP 1.99|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 Armed Assault|COMMENT]]
+
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|arma2|Scripting Commands}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|tkoh|Scripting Commands}}
  
 
<!-- CONTINUE Notes -->
 
<!-- CONTINUE Notes -->
Line 63: Line 55:
  
 
</dd>
 
</dd>
</dl>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
 
<dd class="notedate">Posted on November 4, 2016 - 20:46 (UTC)</dd>
 
<dd class="notedate">Posted on November 4, 2016 - 20:46 (UTC)</dd>
<dt class="note">[[User:Revo|Revo]]</dt>
+
<dt class="note">[[User:R3vo|R3vo]]</dt>
 
<dd class="note">
 
<dd class="note">
 
'''comment''' can also be used to create comments inside trigger activation fields where <tt>//</tt> or <tt>/*...*/</tt> don't work.
 
'''comment''' can also be used to create comments inside trigger activation fields where <tt>//</tt> or <tt>/*...*/</tt> don't work.

Latest revision as of 23:30, 16 February 2021

Introduced with Operation Flashpoint: Resistance version 1.851.85
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.
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.

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

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.
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.