Reverse engineering processes the first comment block of the function between two lines of slash characters.
///////////////////////////////////////////////////////////////////////// // <FuncType>: <Operation signature> // Description: <Operation comment line1> // <Operation comment line2> // Access: <visibility> // Arguments: <parameter1 name> - <parameter1 comment line1> // <parameter1 comment line2> // <parameter2 name> - <parameter2 comment> // Returns: <Return comment> // <Return comment2> /////////////////////////////////////////////////////////////////////////
If all generated keywords are found, the block will be removed and relevant attributes will be set:
|
Keywords attribute |
Corresponding operation attribute |
|---|---|
|
FuncType, Subroutine, Event |
Name |
|
Description |
Operation comment |
|
Access |
Visibility property |
|
Arguments |
Parameter(s) name and comment |
|
Returns |
Value for ReturnComment extended attribute |
|
User-defined comment |
Value for UserDefinedComment extended attribute |
|
GenerateHeader |
Set to True |
|
Other function comments |
Kept in operation body |
Otherwise, the function comments are kept in the operation body and the GenerateHeader extended attribute set to false.