COMMENT

C Test Script Language

Purpose

The COMMENT instruction adds a textual comment to the test report.

Syntax

COMMENT [<text>]

Argument

<text> is an optional text string to be displayed.

Description

The COMMENT instruction is optional and can be used anywhere in the test script.

The position of the COMMENT instruction in the test script determines the position where the comment is displayed in the test report:

  • Before the first SERVICE block: the comment is displayed after the report information header and before the first service.

  • Inside a SERVICE block: the comment is displayed in the service header, before the test descriptions.

  • Outside a SERVICE block: the comment is displayed in the following service header, before the test descriptions.

  • After the last SERVICE block: the comment is ignored.

  • Inside an ELEMENT block: the comment is displayed before the variable state descriptions.

  • After a TEST instruction: the comment is displayed in the test header, before the variable descriptions.

Example

TEST 1

FAMILY nominal

COMMENT histogram computation for a black image

ELEMENT

Related Topics

ELEMENT | TEST | SERVICE