[Gambas-user] Help comments are now exported

[Willy Raets]

On Sat, 2012-11-10 at 01:26 +0100, Benoît Minisini wrote:
> Hi,
> 
> Since revision #5311, help comments are now exported by the compiler 
> into the information files of libraries and components (*.info files).
> 
> Consequently, if you define some help in your libraries, you will see 
> them in the IDE!
> 
)))) YES ((((

> Help comments must begin with two quotes and a space (`'' `), and must 
> be located:
> 
> - On the same line of the declaration of the documented symbol.
> 
> - Or on several lines just before the declaration of the documented symbol.
> 
> A class can have its own help comments. The class help comments must 
> begin with three quotes and a space (`''' `), and must be the first help 
> comments of the class source file.
> 
> Note: The syntax used in help comments is a Gambas markup language 
> mainly inspired from the Markdown markup language. [1]
> 
> Enjoy it!
> 
> [1] http://en.wikipedia.org/wiki/Markdown
> 

Thank you Benoît, you've made my day :-)

Willy