IDLdoc

For a detailed discussion about IDLdoc, refer to Advanced Code Commenting with IDLdoc.

You can modify the following preferences on the Preferences → IDL → IDLdoc preferences page:

Option
Description
Default

Comments tabs

Click one of the comments tabs to display the text for the associated IDLdoc comment block.

A routine comment template contains the boilerplate text for an IDLdoc comment block that describes an IDL routine.

A file comment template contains the boilerplate text for an IDLdoc comment block that describes an entire IDL source code file.

You can edit the text in an IDLdoc comment block template by changing text in the tab editor or by inserting a variable.

In an IDLdoc comment block, every line begins with the semicolon ( `;' ) comment character. A block begins with the ";+" string, and ends with the ";-" string. IDLdoc tags are delimited by the `:' character, and variables are of the format $(string).

Routine Comments

Insert Variable

There are several ways to insert a variable in an IDLdoc comment block template:

  • Click Insert Variable
  • Type Ctrl+Space
  • Right-click the mouse, and from the context menu select Insert Variable.
  • Type the `$' character anywhere in the comment block editor (this allows you to select only ${var} variables.

Any of the above methods displays a list of valid variables you can insert at a given location in the comment block. The selected variable type is explained in a box to the right of the list.

There are three types of variables (tags) that can be embedded in a comment block:

  • Colon Tags - Define a section heading within a comment block.

    • Example: :Abstract:

  • Dollar Tags - Define a variable that is evaluated during comment block insertion into the document.

    • Example: ${date}

  • Generic Attributes - Applied to a routine's positional parameters and keywords.

    • Example: Type=

None

Add Routine Comments

These radio buttons determine if a routine comment block is inserted above or below the routine declaration. This preference does not affect file comment blocks.

Above Declaration