[Gambas-user] Adding Documentation to functions

[Benoît Minisini]

Le 19/01/2020 à 23:34, Bruce a écrit :
> 
> Also, one thing that I never realised until recently is that you can add 
> inline help comments to local variable declarations:
> 
> Private Sub Thingo ( ahab as integer )
> 
>    Dim iWhatsIt as Float           '' The float of the *ahab* parameter
> 
>    ...
> 
>    Return fDooDah / iWha                 <---- and the completion popup 
> shows the iWhatsIt help at this point.
> 
> Not a biggy you might say, but ib in a long procedure revisited some 
> months later it is amazingly useful! (IMHO)
> 
> regards
> Bruce
> 

I'm not sure that it was done on purpose.

By the way, the commented help of exported classes is saved in an help 
file located in the project, and in the executable.

That way, if your project is a library, the help is made available to 
the other projects using the library.

Regards,

-- 
Benoît Minisini