comment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (<pre> to <code>)
m (Some wiki formatting)
 
(70 intermediate revisions by 10 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 <code>[[comment]] "This is a commented line"</code> |= Example 1
|x2= function.sqf <code>[[comment]] "This is a commented line";</code> |= Example 2
____________________________________________________________________________________________


| [[Control Structures]] |= See also
|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 December 17, 2006 - 19:13
<dt class="note">'''[[User:Pennywise|Pennywise]]'''<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:
* comment {string...};
* comment { CoC Network Service 2.0
            CoC bn880 28/02/2004; example comment};


|p1= text: [[String]] - the comment


|r1= [[Nothing]]


<dd class="notedate">Posted on September 12, 2009 - 19:50
|x1= In a preprocessed SQF script (e.g. when doing <sqf inline>execVM "myScript.sqf"</sqf>)
<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 :
<sqf>
comment "
comment "This is a commented line"; // bad
first line
"This is a commented line"; // slightly better
seconde line";
// This is a commented line // perfect
</sqf>




<!-- Note Section END -->
|x2= In an object init field (in editor):
</dl>
<sqf>
comment "This comment works";
"This comment works too";
// This doesn't work
/* This doesn't work either */
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[Control Structures]]
}}


[[Category:Scripting Commands|COMMENT]]
{{Note
[[Category:Scripting Commands OFP 1.96|COMMENT]]
|user= Tom_48_97
[[Category:Scripting Commands ArmA|COMMENT]]
|timestamp= 20090912195000
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
|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 :
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
<sqf>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
comment "
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
first line
seconde line";
</sqf>
}}

Latest revision as of 19:56, 7 April 2024

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";