Difference between revisions of "comment"

From Bohemia Interactive Community
Jump to navigation Jump to search
(updated)
m (Text replacement - "]]<dd class="note">" to "]]</dt> <dd class="note">")
 
(65 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| ofpr |= Game name
+
|game1= ofp
 +
|version1= 1.85
  
|1.85|= Game version
+
|game2= ofpe
____________________________________________________________________________________________
+
|version2= 1.00
  
| Define a comment.  
+
|game3= arma1
 +
|version3= 1.00
  
Mainly used in [[SQF_syntax|SQF Syntax]], as you're able to introduce comment lines with semicolons in a [[sqs syntax|SQS script]]. |= Description
+
|game4= arma2
____________________________________________________________________________________________
+
|version4= 1.00
  
| '''comment''' comment |= Syntax
+
|game5= arma2oa
 +
|version5= 1.50
  
|p1= comment: [[String]] - the comment that you'd like to write here |= Parameter 1
+
|game6= tkoh
 +
|version6= 1.00
  
| [[Nothing]] |= Return value
+
|game7= arma3
____________________________________________________________________________________________
+
|version7= 0.50
 
 
|x1= script.sqs <pre>comment "This is a commented line"</pre> |= Example 1
 
|x2= function.sqf <pre>comment "This is a commented line";</pre> |= Example 2
 
____________________________________________________________________________________________
 
  
| [[Control Structures]] |= See also
+
|gr1= Strings
  
 +
|descr= Defines a comment. See {{HashLink|SQF Syntax#Comments}} to learn more about comments.
 +
{{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.}}
 +
 +
|s1=  [[comment]]  text
 +
 +
|p1= text: [[String]] - The comment
 +
 +
|r1= [[Nothing]]
 +
 +
|x1= <code>[[comment]] "This is a commented line";</code>
 +
 +
|seealso= [[Control Structures]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
+
 
<dd class="notedate">Posted on December 17, 2006 - 19:13</dd>
+
<dt><dt>
<dt class="note">'''[[User:Pennywise|Pennywise]]'''</dt><dd class="note">ArmA 1.0-1.2 brackets, {}, can no longer be used with comment. The following examples, which worked in OFP, no long work for ArmA:
+
<dd class="notedate">Posted on September 12, 2009 - 19:50</dd>
  * comment {string...};
+
<dt class="note">[[User:Tom_48_97|Tom_48_97]]</dt>
* comment { CoC Network Service 2.0
+
<dd class="note">Like {{arma1}}, you can not use brackets to make a multi-lines comment. But, in a sqf file, you can make a comment as follow :
            CoC bn880 28/02/2004; example comment};
+
<code>[[comment]] "
 +
  first line
 +
seconde line";</code>
 +
<dt></dt>
 +
<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>
  
<!-- Note Section END -->
+
<dt><dt>
 +
<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>
 
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
 
[[Category:Scripting Commands|COMMENT]]
 
[[Category:Scripting Commands OFP 1.96|COMMENT]]
 
[[Category:Scripting Commands ArmA|COMMENT]]
 
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 19:32, 12 June 2021

Hover & click on the images for description

Description

Description:
Defines a comment. See SQF Syntax - Comments to learn more about comments.
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 text
Parameters:
text: String - The comment
Return Value:
Nothing

Examples

Example 1:
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
Posted on September 12, 2009 - 19:50
Tom_48_97
Like Armed Assault, you can not 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.