Notes, Comments and Logs - Revision history

Ivailop at 21:42, 23 October 2014

2014-10-23T21:42:22Z

← Older revision		Revision as of 21:42, 23 October 2014
Line 11:		Line 11:
	\| Note\|\| Macro \|\| Adds a time-stamped string under a test case. An annotation that is macro-ized to simplify its use. Most used technique.		\| 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~~		\| Comment\|\| API \|\| Allows you to add a labeled comment to an annotation
	\|-		\|-
	\| Log\|\| Macro \|\| Designed for use in the code under test (instead of the test); allows selective inclusion according to log level		\| Log\|\| Macro \|\| Designed for use in the code under test (instead of the test); allows selective inclusion according to log level

Timd at 23:51, 22 June 2012

2012-06-22T23:51:05Z

← Older revision		Revision as of 23:51, 22 June 2012
Line 1:		Line 1:
			-= Document in progress =-

	==Summary==		==Summary==

Timd: f

2012-06-22T23:50:33Z

New page

==Summary==

{| border="1" cellspacing="0" cellpadding="10" style="align:left;"
! 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 [[Test_Macros#Notes|srNOTE macros]].<ref>A note is a special case of a [[Runtime_Test_Services#method_AddAnnotation|test annotation]]</ref>
srNOTE_[level](msg)

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

==Comments==

==Logs==

---
<references/>