[fpc-pascal] Documentation

[Michael Van Canneyt]

On Mon, 17 Dec 2012, dev.dliw at gmail.com wrote:

> 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.

Well, I have planned a inline-to-external conversion for fpdoc for exactly this reason.

Michael.