ClassesClasses | | Operators

Page not available for the currently selected syntax (programming language).

Page not available for the currently selected syntax (programming language).

Page not available for the currently selected syntax (programming language).

commentcommentCommentComment (Operator)

Name

commentcommentCommentComment — Add a comment of one line to the program.

Signature

comment( : : Comment : )

Herror comment(const char* Comment)

Herror T_comment(const Htuple Comment)

void Comment(const HTuple& Comment)

static void HOperatorSet.Comment(HTuple comment)

Description

commentcommentCommentCommentComment allows to add a comment of one line to the program. As parameter value, i.e., as comment, all characters are allowed. If the operator window is used to enter a comment and if there are newlines in the comment line parameter, one comment statement for every text line is inserted.

In the full text editor a comment is marked by entering an asterisk ('*'"*""*""*""*") as first non-whitespace character.

This operator has no effect on the program execution.

Parameters

CommentCommentCommentCommentcomment (input_control)  string HTupleHTupleHtuple (string) (string) (HString) (char*)

Arbitrary sequence of characters.

Example (HDevelop)

* This is a program with comments
* 'this is a string as comment'
* here are numbers: 4711, 0.815
stop ()

Result

commentcommentCommentCommentComment is never executed.

Module

Foundation


ClassesClasses | | Operators