Documentation: Difference between revisions
m
→{{header|Phix}}: added syntax colouring, marked p2js compatible
Puppydrum64 (talk | contribs) No edit summary |
m (→{{header|Phix}}: added syntax colouring, marked p2js compatible) |
||
Line 1,127:
from the project tree of the last run/file being edited. Pressing F1 again cycles through them.<br>
Ideally any routine-specific comments should be placed within the routine itself, eg (from pmain.e):
<!--<lang Phix>
<span style="color: #008080;">procedure</span> <span style="color: #000000;">StoreVar</span><span style="color: #0000FF;">(</span><span style="color: #004080;">integer</span> <span style="color: #000000;">N</span><span style="color: #0000FF;">,</span> <span style="color: #004080;">integer</span> <span style="color: #000000;">NTyp</span><span style="color: #0000FF;">)</span>
<span style="color: #000080;font-style:italic;">--
-- Store a variable, applying any final operator as needed.
-- If N is zero, PopFactor (ie store in a new temporary variable of
-- the specified type). Otherwise N should be an index to symtab.
-- If storeConst is 1, NTyp is ignored/overridden, otherwise it
-- should usually be the declared or local type of N.
-- </span>
<span style="color: #0000FF;">...</span>
<span style="color: #008080;">end</span> <span style="color: #008080;">procedure</span>
<!--</lang>-->
Note: As I understand it, tools such as Doxygen usually expect their markup to precede the actual definitions.
| |||