Difference between revisions of "comment"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
 
(42 intermediate revisions by 23 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
+
{{Command|= Comments
[[Category:Scripting Commands OFP 1.97]]
+
____________________________________________________________________________________________
[[Category:Scripting Commands ArmA]]
 
  
back to [[Scripting_Reference#C|COMREF]]
+
| ofpr |= Game name
  
<h2 style="color:#000066"> '''comment ''comment'''''</h2>
+
|1.85|= Game version
 +
____________________________________________________________________________________________
  
 +
| Define a comment.
  
'''Operand types:'''
+
Mainly used in [[SQF_syntax|SQF Syntax]], as you're able to introduce comment lines with semicolons in a [[sqs syntax|SQS script]].<br>
 +
{{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=
 +
____________________________________________________________________________________________
  
'''comment:''' [[String]]
+
| '''comment''' commentMsg |SYNTAX=
  
'''Type of returned value:'''
+
|p1= commentMsg: [[String]] - the comment that you'd like to write here |PARAMETER1=
  
[[Nothing]]
+
| [[Nothing]] |RETURNVALUE=
 +
____________________________________________________________________________________________
 +
 
 +
|x1= script.sqs <code>[[comment]] "This is a commented line"</code> |EXAMPLE1=
 +
|x2= function.sqf <code>[[comment]] "This is a commented line";</code> |EXAMPLE2=
 +
____________________________________________________________________________________________
  
'''Compatibility:'''
+
| [[Control Structures]] |SEEALSO=
  
Added in version '''1.85'''
+
}}
  
'''Description:'''
+
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
  
Do nothing, used to insert comments.
+
<dd class="notedate">Posted on September 12, 2009 - 19:50
 +
<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>
  
  
'''Example:'''
+
<!-- Note Section END -->
 +
</dl>
  
'''comment''' "This is a comment"
+
<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]]
 +
[[Category:Scripting Commands ArmA|COMMENT]]
 +
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands ArmA2|{{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>
 +
<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>.
 +
 
 +
</dd>
 +
</dl>
 +
<!-- DISCONTINUE Notes -->
 +
 
 +
<!-- CONTINUE Notes -->
 +
<dl class="command_description">
 +
<dd class="notedate">Posted on November 4, 2016 - 20:46 (UTC)</dd>
 +
<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 15:35, 7 April 2019

Introduced with Operation Flashpoint: Resistance version 1.85
  

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint: Resistance
Version:
1.85

Description

Description:
Define a comment. Mainly used in SQF Syntax, as you're able to introduce comment lines with semicolons in a SQS script.
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.

Syntax

Syntax:
comment commentMsg
Parameters:
commentMsg: String - the comment that you'd like to write here
Return Value:
Nothing

Examples

Example 1:
script.sqs comment "This is a commented line"
Example 2:
function.sqf comment "This is a commented line";

Additional Information

Multiplayer:
-
See also:
Control Structures

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Posted on September 12, 2009 - 19:50
Tom_48_97
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";

Bottom Section

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)
Revo
comment can also be used to create comments inside trigger activation fields where // or /*...*/ don't work.