[Lazarus] Documentation style
Mattias Gaertner
nc-gaertnma at netcologne.de
Sat Jul 23 16:18:29 CEST 2011
On Sat, 23 Jul 2011 15:29:45 +0200
Jürgen Hestermann <juergen.hestermann at gmx.de> wrote:
> >> Many descriptions only describe the obvious, like method names
> expressed
> >> in more words. Such descriptions are quite useless, and should be
> >> replaced by more informative ones. I'd suggest to remove all these
> >> descriptions (replace by a todo-marker?), until somebody can describe
> >> the elements better.
> > I doubt that this should be done for all.
> > What if the method just does what the name says?
>
> Then no extra documentation is needed.[...]
How to distinguish an item that needs documentation and an
item that does not need documentation?
Mattias
More information about the Lazarus
mailing list