comment: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<tt>([^= ]+)<\/tt>" to "{{hl|$1}}")
m (Some wiki formatting)
Line 25: Line 25:


|descr= Defines a comment. See {{HashLink|SQF Syntax#Comments}} to learn more about comments.
|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 ({{hl|//comment}} or {{hl|/*comment*/}}) which do not exist at runtime). See [[SQF Syntax|SQF Syntax]] for additional documentation on comments.}}
{{Feature|Warning|This command is evaluated during execution, and as such is infinitely slower than other SQF comment methods ({{hl|{{cc|comment}}}} or {{hl|{{codecomment|/* comment */}}}}) 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";}}}}
{{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; e.g {{ic|"Some comment";}}.}}


|s1= [[comment]] text
|s1= [[comment]] text


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


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[[comment]] "This is a commented line";</code>
|x1= <sqf>
comment "This is a commented line"; // bad
"This is a commented line"; // good
// This is a commented line // perfect
</sqf>


|seealso= [[Control Structures]]
|seealso= [[Control Structures]]
}}
}}


<dl class="command_description">
{{Note
 
|user= Tom_48_97
<dt><dt>
|timestamp= 20090912195000
<dd class="notedate">Posted on September 12, 2009 - 19:50</dd>
|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 :
<dt class="note">[[User:Tom_48_97|Tom_48_97]]</dt>
<sqf>
<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 :
comment "
<code>[[comment]] "
  first line
  first line
  seconde line";</code>
  seconde line";
<dt></dt>
</sqf>
}}

Revision as of 17:09, 5 April 2022

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 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; e.g "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"; // bad "This is a commented line"; // good // This is a commented line // perfect

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=308842"