On Monday 16 October 2006 15:27, Derek Smithies wrote:
> Nick,
>  There is another issue that you have not mentioned, that is quite
> relevant.
>
> Some coders say, "We wrote it as quickly as possible", or "did not want to
> clutter the source up with doxygen like comments", or "had trouble with
> the different documentation tools", or "the code is moving too quickly to
> write documentation", or some other excuse.
>  At the end of the day, you end up with hundreds of thousands of lines of
> code, and no reasonable guide as to why things were done what &where.

very true! this also applies to user docs, ie how to run the bloody thing - 
which is a different but related problem to the source code documentation 
that you speak of. As a linux-literate person, I wouldn't really read much 
c/c++ source code, but I read a lot of README and man pages!

Reply via email to