In Safe X3 sources files, comments on methods (funprogs, subprogs and labels) can be inserted as javadoc like documentation. These documentations must be inserted just before methods declaration. They can be used to give explanations about what methods do, their parameters, etc. Note that if no documentation is provided for a method, a default one is displayed containing method prototype, with qualified parameters.
This kind of documentation is displayed in a tooltip when the method name is hovered or when you press F2.
Alternatively, you can bring to front the X3 Documentation view and then select the element's name in the editor.
Javadoc documentation starting marker is #**, ending one is #*!.
As soon as starting marker is typed and ENTER is pressed, a template documentation is inserted.
It contains as much lines as method parameters, and a line with an ending marker.
Note that this mechanism only appends if Automatically close > Javadoc > Add Javadoc tags preference is checked in
Safe X3 Studio > Editor > Typing preference page.
Source code below shows generated javadoc for subprogram TEST.
#**
#*
#* @param P1
#* @param P2
#* @param P3
#*!
Subprog TEST(P1, P2, P3)
...
Javadoc tags can be inserted in this kind of documentation.
They allow to format more readable documentations in tooltips and in X3 Documentation view.
Safe X3 javadoc tags are :
Javadoc like documentation sample (displayed in a tooltip):

Documentations stored in subprograms documentation table (ASUBPROG) are displayed as if they were present in source files.
