Difference between revisions of "comment"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (parameter should not have same name as command)
m (cleaned up notes, added info about comments in triggers)
 
(59 intermediate revisions by 8 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''' commentMsg |= Syntax
+
|game5= arma2oa
 +
|version5= 1.50
  
|p1= commentMsg: [[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 {{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 (<tt>//comment</tt> or <tt>/*comment*/</tt>) which do not exist at runtime). See [[SQF Syntax|SQF Syntax]] for additional documentation on comments.}}
 +
{{Feature|Informative|In order to place comments inside trigger activation fields and similar, use a plain string followed by a semicolon as a way to comment {{ic|"Some comment";}}}}
  
<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= <code>[[comment]] "This is a commented line";</code>
<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 :
 
comment "
 
first line
 
seconde line";
 
  
 +
|seealso= [[Control Structures]]
 +
}}
  
<!-- Note Section END -->
+
<dl class="command_description">
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
<dt><dt>
 
+
<dd class="notedate">Posted on September 12, 2009 - 19:50</dd>
[[Category:Scripting Commands|COMMENT]]
+
<dt class="note">[[User:Tom_48_97|Tom_48_97]]</dt>
[[Category:Scripting Commands OFP 1.99|COMMENT]]
+
<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 :
[[Category:Scripting Commands OFP 1.96|COMMENT]]
+
<code>[[comment]] "
[[Category:Scripting Commands ArmA|COMMENT]]
+
first line
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
+
seconde line";</code>
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
<dt></dt>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 17:53, 6 July 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.
In order to place comments inside trigger activation fields and similar, use a plain string followed by a semicolon as a way to comment "Some comment";
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";