2021 September Release

CommentsPermanent link for this heading

To improve the readability of a test it can be useful to add comments. There are three different types of comment:

  • With the // symbol the rest of the line is interpreted as comment.
  • With the /* symbol everything up to the */ symbol is interpreted as comment, including newlines.
  • With the /** symbol everything up to the */ symbol is interpreted as comment, including newlines. Additionally, this comment is added to the result file as <comment> element. Inside this type of comment, parameter replacement can be used just like in a string variable.

Example

/*
* this is an example of a multiple lines test
* with four lines.
*/

test "Comments" {

  /**
   * this comment will be written before the assignment
   */
  testparam = "parameter" // comment until end of line

  /**
   * session comment
   * test name: {~testparam~}
   */
  session CommentsS1() {
  }
}