You
can reach this dialog box by using the ‘Function’ sub-menu of the
‘Description’ option in the ‘Edit’ menu bar. Or you can go to the
‘Edit’ menu bar, choose ‘Description’, then ‘Function’.
To use this function, place the cursor at the beginning of a function and choose the Edit->Description->Function option from the menu. This will produce the display of the following dialog box:
|
|
|
You
can reach this dialog box by using the ‘Function’ sub-menu of the
‘Description’ option in the ‘Edit’ menu bar. Or you can go to the
‘Edit’ menu bar, choose ‘Description’, then ‘Function’. |
If you fill in the fields and Wedit cannot verify the information you type, the prototype of the function is displayed at the bottom. Do not modify the first two fields: They are maintained automatically by the editor.
The ‘Purpose’ field is for a general description of the function algorithm and any general notes that are necessary for understanding how the function works.
The ‘Inputs’ field is for commenting on the argument that the function receives and any global variables it uses.
The ‘Output’ field is for documenting the return result and any modifications the function makes to its global environment.
The ‘Error handling’ field is for documenting what happens in the event of an error, including what error checks are run, etc.
These special comments would not be useful if they could not be modified. The editor recognizes these types of comments and will parse its contents and display them if you choose this option again and there is already a special comment similar to this.