comment: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "{{Feature|Warning|" to "{{Feature|warning|") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
Line 25: | Line 25: | ||
|descr= Defines a comment. See {{Link|SQF Syntax#Comments}} to learn more about comments. | |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|warning| | ||
{{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>.}} | 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>. | |||
}} | |||
|s1= [[comment]] text | |s1= [[comment]] text | ||
Line 34: | Line 40: | ||
|r1= [[Nothing]] | |r1= [[Nothing]] | ||
|x1= In a preprocessed SQF script (e.g. when doing | |x1= In a preprocessed SQF script (e.g. when doing <sqf inline>execVM "myScript.sqf"</sqf>) | ||
<sqf> | <sqf> | ||
comment "This is a commented line"; // bad | comment "This is a commented line"; // bad |
Latest revision as of 19:56, 7 April 2024
Description
- Description:
- Defines a comment. See SQF Syntax - Comments to learn more about comments.
- Groups:
- Strings
Syntax
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
- 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";
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.85
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Strings