Using ILE Doc

Use ILE Doc to document your source and view the documentation as HTML. ILE Doc is similar to Javadoc but uses ordinary // comments. Constants, fields, subprocedures, subroutines, and the program as a whole can be documented.

Procedure

  1. Open your source member.
  2. Open the ILE Doc view by pressing CTRL-i or searching for the view in Window > Show View.
  3. Add comments, change comments, or view existing comments.
    Comments at the top of the source member, immediately preceeding a section of code, or on the same line as code will be included in ILE Doc. Comments spanning multiple lines can be included as long as they are not separated by a blank line. If there is a comment that you do not want included, use the tag @exclude within the comment. To refresh the view, click the refresh icon in the ILE Doc view. To save the documentation as an HTML file, click the save icon in the ILE Doc view.
    ILE Doc example