Comments - Revision history

Bale at 09:00, 17 July 2010

2010-07-17T09:00:12Z

← Older revision		Revision as of 09:00, 17 July 2010
Line 31:		Line 31:
	this line will generate an error since it is not commented		this line will generate an error since it is not commented
	</syntaxhighlight>}}		</syntaxhighlight>}}
	[[Category:Miscellaneous ASH Features]][[Category:~~ASH~~ Scripting]]		[[Category:Miscellaneous ASH Features]][[Category:Scripting]]

StDoodle at 06:50, 24 May 2010

2010-05-24T06:50:37Z

← Older revision		Revision as of 06:50, 24 May 2010
Line 31:		Line 31:
	this line will generate an error since it is not commented		this line will generate an error since it is not commented
	</syntaxhighlight>}}		</syntaxhighlight>}}
	[[Category:Miscellaneous ASH Features]]\|[[Category:ASH Scripting]]		[[Category:Miscellaneous ASH Features]][[Category:ASH Scripting]]

Bale at 07:16, 23 May 2010

2010-05-23T07:16:42Z

← Older revision		Revision as of 07:16, 23 May 2010
Line 31:		Line 31:
	this line will generate an error since it is not commented		this line will generate an error since it is not commented
	</syntaxhighlight>}}		</syntaxhighlight>}}
	[[Category:Miscellaneous ASH Features]]		[[Category:Miscellaneous ASH Features]]\|[[Category:ASH Scripting]]

Heeheehee: History lesson nuked.

2010-05-02T17:16:56Z

History lesson nuked.

← Older revision		Revision as of 17:16, 2 May 2010
Line 21:		Line 21:
	this line will generate an error since it is not commented		this line will generate an error since it is not commented
	</syntaxhighlight>}}		</syntaxhighlight>}}
	~~Note that as of r8400, the opening and closing symbols for block comments no longer need to be on their own lines.~~

	As far as KoLmafia is concerned when running the script, that entire example looks like this:		As far as KoLmafia is concerned when running the script, that entire example looks like this:

Heeheehee: Yay, new info regarding block comments!

2010-04-24T17:18:21Z

Yay, new info regarding block comments!

← Older revision		Revision as of 17:18, 24 April 2010
Line 3:		Line 3:
	It is generally considered good practice when writing a script to include a few comments explaining the purpose of various sections, especially to clarify any difficult-to-understand parts.		It is generally considered good practice when writing a script to include a few comments explaining the purpose of various sections, especially to clarify any difficult-to-understand parts.

	ASH has three different options for commenting -- the pound sign (#), the double forward slash (//), and the block comment (everything between /* and */). See the following example:		ASH has three different options for commenting -- the pound sign (#), the double forward slash (//), and the block comment (everything between /* and */). See the following example:
	{{CodeSample\|		{{CodeSample\|
	code=		code=
Line 11:		Line 11:

	/*		/*
	This is part of a block comment.		This is part of a block comment.
	That means that all of this is commented.		That means that all of this is commented.
	Commands within comments are not executed.		Commands within comments are not executed.
	print("This will not be printed.");		print("This will not be printed.");
	~~Note that the opening and closing symbols for block comments must be on their own lines!~~
	*/		*/

Line 22:		Line 21:
	this line will generate an error since it is not commented		this line will generate an error since it is not commented
	</syntaxhighlight>}}		</syntaxhighlight>}}
			Note that as of r8400, the opening and closing symbols for block comments no longer need to be on their own lines.

	As far as KoLmafia is concerned when running the script, that entire example looks like this:		As far as KoLmafia is concerned when running the script, that entire example looks like this:

StDoodle at 09:10, 13 April 2010

2010-04-13T09:10:25Z

← Older revision		Revision as of 09:10, 13 April 2010
Line 32:		Line 32:
	this line will generate an error since it is not commented		this line will generate an error since it is not commented
	</syntaxhighlight>}}		</syntaxhighlight>}}
			[[Category:Miscellaneous ASH Features]]

StDoodle at 09:09, 13 April 2010

2010-04-13T09:09:40Z

← Older revision		Revision as of 09:09, 13 April 2010
Line 22:		Line 22:
	this line will generate an error since it is not commented		this line will generate an error since it is not commented
	</syntaxhighlight>}}		</syntaxhighlight>}}



	As far as KoLmafia is concerned when running the script, that entire example looks like this:		As far as KoLmafia is concerned when running the script, that entire example looks like this:

StDoodle at 09:09, 13 April 2010

2010-04-13T09:09:25Z

← Older revision		Revision as of 09:09, 13 April 2010
Line 4:		Line 4:

	ASH has three different options for commenting -- the pound sign (#), the double forward slash (//), and the block comment (everything between /* and */). See the following example:		ASH has three different options for commenting -- the pound sign (#), the double forward slash (//), and the block comment (everything between /* and */). See the following example:
			{{CodeSample\|
	<~~code~~>		code=
	# this entire line is commented		<syntaxhighlight>
	// so is this entire line		# this entire line is commented
			// so is this entire line

	/*		/*
	This is part of a block comment.		This is part of a block comment.
	That means that all of this is commented.		That means that all of this is commented.
	Commands within comments are not executed.		Commands within comments are not executed.
	print("This will not be printed.");		print("This will not be printed.");
	Note that the opening and closing symbols for block comments must be on their own lines!		Note that the opening and closing symbols for block comments must be on their own lines!
	*/		*/

	print("This will be printed."); // Single-line comments can be on the same line as commands.		print("This will be printed."); // Single-line comments can be on the same line as commands.

	this line will generate an error since it is not commented		this line will generate an error since it is not commented
	</~~code~~>		</syntaxhighlight>}}



	As far as KoLmafia is concerned when running the script, that entire example looks like this:		As far as KoLmafia is concerned when running the script, that entire example looks like this:

	<~~code~~>		{{CodeSample\|
	print("This will be printed.");		code=
			<syntaxhighlight>
			print("This will be printed.");

	this line will generate an error since it is not commented		this line will generate an error since it is not commented
	</~~code~~>		</syntaxhighlight>}}

Zarqon: created page

2009-01-30T18:45:46Z

created page

New page

A comment is non-functional text in a script, which is ignored by KoLmafia when running the script. They are most commonly included to help someone reading/editing the script (including the script author!) to understand or navigate the script. Sometimes commands are "commented out" during debugging, to prevent them from being executed while testing.

It is generally considered good practice when writing a script to include a few comments explaining the purpose of various sections, especially to clarify any difficult-to-understand parts.

ASH has three different options for commenting -- the pound sign (#), the double forward slash (//), and the block comment (everything between /* and */). See the following example:

<code>
# this entire line is commented
// so is this entire line

/*
This is part of a block comment.
That means that all of this is commented.
Commands within comments are not executed.
print("This will not be printed.");
Note that the opening and closing symbols for block comments must be on their own lines!
*/

print("This will be printed."); // Single-line comments can be on the same line as commands.

this line will generate an error since it is not commented
</code>

As far as KoLmafia is concerned when running the script, that entire example looks like this:

<code>
print("This will be printed.");

this line will generate an error since it is not commented
</code>