comment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Armed[ _]Assault(\|.*)]]" to "{{GameCategory|arma1|Scripting Commands}}")
m (Text replacement - "\|s1= +" to "|s1= ")
(32 intermediate revisions by 2 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


|gr1= Strings |GROUP1=
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Define a comment.  
|game4= arma2
|version4= 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]].<br>
|game5= arma2oa
{{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=
|version5= 1.50
____________________________________________________________________________________________


| '''comment''' commentMsg |SYNTAX=
|game6= tkoh
|version6= 1.00


|p1= commentMsg: [[String]] - the comment that you'd like to write here |PARAMETER1=
|game7= arma3
|version7= 0.50


| [[Nothing]] |RETURNVALUE=
|gr1= Strings
____________________________________________________________________________________________
 
|x1= script.sqs <code>[[comment]] "This is a commented line"</code> |EXAMPLE1=
|x2= function.sqf <code>[[comment]] "This is a commented line";</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[Control Structures]] |SEEALSO=
|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 September 12, 2009 - 19:50
<dt><dt>
<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 :
<dd class="notedate">Posted on September 12, 2009 - 19:50</dd>
<dt class="note">[[User:Tom_48_97|Tom_48_97]]</dt>
<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 :
<code>[[comment]] "
<code>[[comment]] "
  first line
  first line
  seconde line";</code>
  seconde line";</code>
 
<dt></dt>
 
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|COMMENT]]
[[Category:Scripting Commands OFP 1.99|COMMENT]]
[[Category:Scripting Commands OFP 1.96|COMMENT]]
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands Arma 2|{{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>
<dd class="notedate">Posted on November 4, 2016 - 16:17 (UTC)</dd>
<dt class="note">[[User:Tofof|Tofof]]</dt>
<dt class="note">[[User:Tofof|Tofof]]</dt>
<dd class="note">
<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>.
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>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<dt><dt>
<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:R3vo|R3vo]]</dt>
<dt class="note">[[User:R3vo|R3vo]]</dt>
Line 73: Line 60:
'''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.
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 16:41, 19 June 2021

Logo A0.png1.85ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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.
Retrieved from "https://community.bistudio.com/wiki?title=comment&oldid=283610"