[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: svn commit: r18486 - trunk/subversion/libsvn_ra_serf

From: Peter N. Lundblad <peter_at_famlundblad.se>
Date: 2006-02-19 22:23:24 CET

On Fri, 17 Feb 2006 kfogel@collab.net wrote:

> "Peter N. Lundblad" <peter@famlundblad.se> writes:
> > Well...
> >
> > "For structure types, document each individual member of the structure as
> > well as the structure itself."
> >
> > I think that's a little overkill.
>
> No, I think it really helps. There have been many times where I've
> been reviewing a commit and found that lack of structure field
> documentation impeded my ability to understand things (in fact, you'll
> sometimes see followup commits from me adding the documentation).
>
Karl,

What I mean is that *often* documentation for internal structs and fields
is useful, but one could apply some common sense. Sometimes, the purpose
of the filed is just so obvious, that the comment does not add any vaule.

Best,
//Peter

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sun Feb 19 22:24:22 2006

This is an archived mail posted to the Subversion Dev mailing list.