| Excerpt |
|---|
Adds a comment to the test results... |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
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
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
Test("Add a comment?", Test.ANYEXPECT( 1 ), function(_global, 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 Test.EXPECT( ) or Test.START( ) where numResults is specified.
| Div | ||||||
|---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
| Div | ||||
|---|---|---|---|---|
| ||||
ContentsJump to:
|
| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Test APITopics:
|