Notes, Comments and Logs

Summary

Technique	How to Access	Uses
Annotation	API	Allows you to add supplemental information grouped under a heading attached to either a suite or test case
Note	Macro	Adds a time-stamped string under a test case. An annotation that is macro-ized to simplify its use. Most used technique.
Comment	API	Allows you to add a labeled comment to a test case
Log	Macro	Designed for use in the code under test (instead of the test); allows selective inclusion according to log level

Annotations

Annotations allow you to supplement your report with additional detailed information. An annotation comprises two components: a heading and one or more optional comments under the heading. The components break down as follows:

Annotation heading

Level (required) one of six pre-defined levels

Name (optional)

Description (optional)

Annotations may be attached to either a test case or a test suite (test unit).

Notes

Notes are the most-used method of adding supplemental information to a test report from a test. A note is an annotation that has been macro-ized so that is it very convenient to use from your test code.

To add a note, you specify a level and some text.

To add a note, use one of the srNOTE macros. srNOTE_[level](msg)

Notes comprise a string and a level. The level controls how the note string is displayed in the report

Logs

---