autoComment On

The autoComment On command invokes the autocomment feature for the current file.

Syntax

autoComment On [<language_profile_name> |DEFAULT][<base_auto_comment>]
Tip: The autoComment command is case-sensitive; the arguments are not case-sensitive.

Arguments

<language_profile_name>
Specifies the name of the language profile that you want to use.
Tip: It is recommended that you use DEFAULT instead of specifying a language profile when invoking autocomment. If you use DEFAULT, a default language profile is assigned to the file based on the file name extension.
DEFAULT
Assigns a default language profile to the current file based on the file name extension. For example, if the file has an .asm file name extension, the HLASM language profile is applied to the selected file.
Note: If no file name extension association can be determined for the current file type, the C language profile is used by default.
<base_auto_comment>
Specifies the base portion of the autocomment that you want to use. If you do not specify the base autocomment, one of the following occurs:
  • If you specified the <language_profile_name>, a blank auto comment is used.
  • If you did not specify the <language_profile_name>, the last autocomment used in the current editor session is used; if no auto comments have been used in the current session, a blank autocomment is used.
The appropriate append and padding characters (specified in the current language profile) are added to this base autocomment. This constructs the custom autocomment that is inserted into changed lines in the current file.
Tip: To invoke autocomment using a base comment that contains spaces, enclose the base comment with double quotation marks. For example, to invoke autocomment with a base comment of &N, specify the following:
autoComment on "&N"
The &N user variable represents the name of the z/OSĀ® UNIX System Services project. Project level user variables are supported in autocomment commands; file level user variables are not supported.