[Gambas-user] New Gambas markup syntax
Bruce
bbruen at ...2308...
Mon Sep 3 09:21:30 CEST 2012
Last one! [Today :-)]
Given that
a) a help comment appended to a method declaration line overrides all
the wonderful help text I have composed above it, and
b) the code folder hides all the "above the line" help if the prior
method is collapsed.
I rather see that the help was based on the "below the line" approach.
For example:
Public Function Mash(param 1 as Thing) As Mess '' This wonderful
'' method takes a single parameter !!param1!! and mashes it into
'' an incomprehensible !!Mess!!
'' + !!param1!! is the [Thing][] you want mashed
'' ##Usage
'' Use of this method is not recommended for persons under 18 years old.
'' Dim MyMess as Mess
'' MyMess = Mash("Some unsuspecting string")
Dim tmpmuck as new Mess
tmpmuck=Whack(param1)
tmpmuck=Chop(tmpmuck)
tmpmuck=Mangle(tmpmuck)
Return WhatsLeftOf(tmpmuck)
End
regards
Bruce
More information about the User
mailing list