Difference between revisions of "comment"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (cleaned up notes, added info about comments in triggers)
 
(89 intermediate revisions by 24 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|C]]
+
{{RV|type=command
[[Category:Scripting Commands OFP 1.97|C]]
 
[[Category:Scripting Commands ArmA|C]]
 
  
back to [[Scripting_Reference#C|COMREF]]
+
|game1= ofp
 +
|version1= 1.85
  
<h2 style="color:#000066"> '''comment ''comment'''''</h2>
+
|game2= ofpe
 +
|version2= 1.00
  
 +
|game3= arma1
 +
|version3= 1.00
  
'''Operand types:'''
+
|game4= arma2
 +
|version4= 1.00
  
'''comment:''' [[String]]
+
|game5= arma2oa
 +
|version5= 1.50
  
'''Type of returned value:'''
+
|game6= tkoh
 +
|version6= 1.00
  
[[Nothing]]
+
|game7= arma3
 +
|version7= 0.50
  
'''Compatibility:'''
+
|gr1= Strings
  
Added in version '''1.85'''
+
|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";}}}}
  
'''Description:'''
+
|s1= [[comment]]  text
  
Do nothing, used to insert comments.
+
|p1= text: [[String]] - The comment
  
 +
|r1= [[Nothing]]
  
'''Example:'''
+
|x1= <code>[[comment]] "This is a commented line";</code>
  
'''comment''' "This is a comment"
+
|seealso= [[Control Structures]]
 +
}}
 +
 
 +
<dl class="command_description">
 +
 
 +
<dt><dt>
 +
<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]] "
 +
first line
 +
seconde line";</code>
 +
<dt></dt>

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