[lazarus] Documentation added to the site
SMiller1 at stvgb.org
Thu Mar 16 09:20:01 EST 2000
That's pretty straight foward. I would guess we could add something like that to PASDOC so we get the best of PASDOC and that.
I personally like to add my comments (if I add any) to the implementation portion, not to the class. Adding all the comments to the class makes it difficult to read. Adding them right to the procedure's in the class seems like a better/cleaner way to go and would be easier to read.
>>> jarto at starsoft.fi 03/16/00 07:29AM >>>
So far I've just been lurking, so I have to say hi and thank you for
your hard work on Lazarus. I'm looking forward to contributing
something when life gets a bit less hectic :-)
> On Thu, 16 Mar 2000, Michael A. Hess wrote:
> I would also warn against the using of the implementation section;
> it will mean that you must extend pasdoc to a full-blown pascal parser,
> because the implementation can have very difficult constructs.
I haven't used pasdoc, so I don't know how it works but I've usually
written comments to the implementation section in the following
// This one draws the TSmile-component
// This is the main comment area and everything
// I write here is picked up as comments.
Canvas.RectFill(Rect(0,0,Width,Height)); //Clean it
DrawSmile; // :-) <- that's it
Then I have a small program that finds all those comments where
pos('//',SourceLine)=1 and makes html-code from those including
the procedure- and functions-lines.
The documentation looks like:
This one draws the TSmile-component
This is the main comment area and everything
I write here is picked up as comments.
procedure TSmile. and so on.....
To unsubscribe: mail lazarus-request at miraclec.com with
"unsubscribe" as the Subject
archives at http://www.miraclec.com/list_archives/lazarus
More information about the Lazarus