Writing comments in a macro

Add comments to your macro file to describe the purpose or the commands in it.

About this task

To write a comment:
  • Write a slash and an asterisk (/*) to indicate the beginning of the comment.
  • Write the comment.
  • Write an asterisk and a slash (*/) to indicate the end of the comment.

You can put a comment on a line by itself, or you can put it on a line that contains a command or part of a command.

For example, to use a comment to identify the purpose of a macro, write the following line:

/* auth.mac-register new nodes  */

Or you can write a comment to explain something about a command or part of a command:

domain=domain1            /*assign node to domain1  */

Comments cannot be nested and cannot span lines. Every line of a comment must contain the comment delimiters.