[Lazarus] *** GMX Spamverdacht *** Re: Suggestion for TRadioGroup documentation

Martin Frb lazarus at mfriebe.de
Fri Apr 8 18:18:04 CEST 2016


On 08/04/2016 18:10, Jürgen Hestermann wrote:
>
> Not only that it would take a lot of (unneccessary) additional time to 
> wade through
> foreign code (while the original coder already knew this after writing 
> it).
> Also, every bug would become part of the documentation as it is "how 
> it is coded".

Or the person reading the code with the intend of documentation, is more 
clever than this. They could report any suspicious parts, and clarify 
the intend. That way the code would be additionally be checked for bugs.

Bugs where the original implementer may have had a wrong understanding 
of what he was doing. In which case had the original coder documented 
it, the bug would have gone into docs.

Assuming the original coder is available for comment, then a person 
different from that coder can often write much better documentation. 
(simple because then 2 (or more) people will have though about what it 
should be)




More information about the Lazarus mailing list