[Gambas-user] Adding Documentation to functions

[Christof Thalhofer]

Am 19.01.20 um 18:39 schrieb Brian G:

> Can someone help me with how to add descriptions to methods, functions
> and variable such that they show up when browsing the class  in the IDE?

Document classes with three single quotes at the beginning of the class
file.

''' This class does ...

Document public methods, variables, properties, constants and so on with
two single quotes above the declaration

'' This method does

Public Sub DoSth()

If you want to write over several lines, use Shift-Return at the end of
the line.

Alles Gute

Christof Thalhofer

-- 
Dies ist keine Signatur

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <https://lists.gambas-basic.org/pipermail/user/attachments/20200119/70886fc1/attachment.sig>