Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Adds a comment to the test results...

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
comment( message );

Parameters

ParameterTypeMandatoryNotesAPI Version
messageString(tick)A message containing the comment.1.0

Return Values

ValueTypeNotesAPI Version
<error>ErrorMost likely the parameters are wrong.1.0
trueBooleanThe comment was added.1.0

Example

Code Block
themeRDark
languagejavascript
linenumberstrue
Test("Add a comment?", Test.EXPECT( 1 ), function(settings) {
	comment( "Hello World!" );
	// The test will fail because it is EXPECTing 1 result but
	// comment( ) doesn't contribute towards results.
});

Notes

Comments do not count towards result totals when processed by Testby Test.EXPECT( ) or Test.STARTASYNCH( ) where numResults is specified.

Div
classbox
Availability
Status
colourGreen
titleStable

Requires:

Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

Test API

Topics:

Child pages (Children Display)
alltrue
depthall
pageTest API
excerpttrue