[fpc-pascal] Documentation

dev.dliw at gmail.com dev.dliw at gmail.com
Mon Dec 17 18:57:04 CET 2012


Hi,
as the question whether inline or external source docs are the way to go 
(again?) came up, here are my thoughts (currently searching for the "best" 
solution :) ):

I personally prefer external docs (and thus started to use fpdoc);
reasons are uncluttered source, less scrolling and (if you strictly limit 
oneself to 80 chars per line) readability on small screens (mobile).
At the same time, I use short single (!) line comments to functions, very much 
the way pasdoc would use them.

For sources in an early state (moving code around etc.) external documentation 
is really annoying, for the detailed documentation of mature source inline 
docs are simply unsuitable IMHO.

Therefore I would really like to see a feature that combines both approaches,
small inline comments, e.g. for IDE tooltips and overview documentation 
together with the possibility to have more detailed infos in external files.

Don't get me wrong, that's not an complaint...
... I don't how much work it would be to extend fpdoc, but I really would like 
to contribute if I knew where to start [and had some more time...] :)

Btw. I really like the lazarus fpdoc GUI...

Just my 2 cents,
d.l.i.w





More information about the fpc-pascal mailing list