Commentaries are important. Wedit helps you standardize two kinds of commentaries: Those that precede a function definition, which help to clarify what the function does, and those commentaries at the beginning of a module, which describe the contents of the whole module.
|
|
|
|
You reach this dialog box either by using the ‘Description’ sub-menu in the ‘Edit’ menu bar, choosing the ‘’File’ option, or using the contextual menu that opens when you click with the right mouse button somewhere within an open source file. |
|
The
different fields should contain the following information:
"Name": The name of the file. This field is filled in automatically by Wedit.
"Identification": This should be filled in with the user. No control whatever is done on the data entered here.
"Description": Idem.