Adds a comment to the test results... |
Syntax
comment( message ); |
Parameters
| Parameter | Type | Mandatory | Notes | API Version |
|---|---|---|---|---|
| message | String |  | A message containing the comment. | 1.0 |
Return Values
| Value | Type | Notes | API Version |
|---|---|---|---|
| <error> | Error | Most likely the parameters are wrong. | 1.0 |
true | Boolean | The comment was added. | 1.0 |
Example
Test("Add a comment?", Test.EXPECT( 1 ), function() {
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 Test.EXPECT( ) or Test.ASYNCH( ) where numResults is specified.