comment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(56 intermediate revisions by 3 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]].<br>
|game4= arma2
{{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=
|version4= 1.00
____________________________________________________________________________________________


| '''comment''' commentMsg |SYNTAX=
|game5= arma2oa
|version5= 1.50


|p1= commentMsg: [[String]] - the comment that you'd like to write here |PARAMETER1=
|game6= tkoh
|version6= 1.00


| [[Nothing]] |RETURNVALUE=
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50
 
|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=
|gr1= Strings


|descr= Defines a comment. See {{Link|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 (<sqf inline>// comment</sqf> or <sqf inline>/* comment */</sqf>) which get preprocessed and do not exist at runtime).
See [[SQF Syntax|SQF Syntax]] for additional documentation on comments.
}}
{{Feature|informative|
This command is only used to place comments in unpreprocessed codes, such as trigger On Activation field, object init field, etc.
Alternatively, one can use a plain string followed by a semicolon as a way to comment; e.g <sqf inline>"Some comment";</sqf>.
}}
}}


<h3 style="display:none">Notes</h3>
|s1= [[comment]] text
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on September 12, 2009 - 19:50
|p1= text: [[String]] - the comment
<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>


|r1= [[Nothing]]


<!-- Note Section END -->
|x1= In a preprocessed SQF script (e.g. when doing <sqf inline>execVM "myScript.sqf"</sqf>)
</dl>
<sqf>
comment "This is a commented line"; // bad
"This is a commented line"; // slightly better
// This is a commented line // perfect
</sqf>


<h3 style="display:none">Bottom Section</h3>


[[Category:Scripting Commands|COMMENT]]
|x2= In an object init field (in editor):
[[Category:Scripting Commands OFP 1.99|COMMENT]]
<sqf>
[[Category:Scripting Commands OFP 1.96|COMMENT]]
comment "This comment works";
[[Category:Scripting Commands ArmA|COMMENT]]
"This comment works too";
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
// This doesn't work
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
/* This doesn't work either */
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
</sqf>
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
|seealso= [[Control Structures]]
<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>.
{{Note
 
|user= Tom_48_97
</dd>
|timestamp= 20090912195000
</dl>
|text= 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 :
<!-- DISCONTINUE Notes -->
<sqf>
 
comment "
<!-- CONTINUE Notes -->
first line
<dl class="command_description">
seconde line";
<dd class="notedate">Posted on November 4, 2016 - 20:46 (UTC)</dd>
</sqf>
<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 -->

Latest revision as of 20:56, 7 April 2024

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 get preprocessed and do not exist at runtime). See SQF Syntax for additional documentation on comments.
ⓘ
This command is only used to place comments in unpreprocessed codes, such as trigger On Activation field, object init field, etc. Alternatively, one can use a plain string followed by a semicolon as a way to comment; e.g "Some comment";.
Groups:
Strings

Syntax

Syntax:
comment text
Parameters:
text: String - the comment
Return Value:
Nothing

Examples

Example 1:
In a preprocessed SQF script (e.g. when doing execVM "myScript.sqf")
comment "This is a commented line"; // bad "This is a commented line"; // slightly better // This is a commented line // perfect
Example 2:
In an object init field (in editor):
comment "This comment works"; "This comment works too"; // This doesn't work /* This doesn't work either */

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
Tom_48_97 - c
Posted on Sep 12, 2009 - 19:50 (UTC)
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";
Retrieved from "https://community.bistudio.com/wiki?title=comment&oldid=363597"