You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Alexander Mueller <al...@littleblue.de> on 2001/08/09 20:19:46 UTC
Re: CVS update: ADDED:
subversion/bindings/java/jni/org/tigris/subversion REMOVED:
subversion/bindings/java/jni/org/tigris/subversion
Greg Stein schrieb:
> On Thu, Aug 09, 2001 at 05:24:41PM -0000, XelaRellum@tigris.org wrote:
> >...
> > Index: Client.java
> > ===================================================================
> > package org.tigris.subversion.lib;
> >
> > /**
> > * public interface for libsvn_client
> > *
> > * ====================================================================
> > * Copyright (c) 2000-2001 CollabNet. All rights reserved.
> > *
> > * This software is licensed as described in the file COPYING, which
> > * you should have received as part of this distribution. The terms
> > * are also available at http://subversion.tigris.org/license-1.html.
> > * If newer versions of this license are posted there, you may use a
> > * newer version instead, at your option.
> > * ====================================================================
> > *
> > * @author Alexander.Mueller@littleblue.de
> > * @version 0.0
>
> We normally do not attribute specific authors in the SVN files. Personally,
> I would be more comfortable to stick with that precedent.
Hmm. Personally I do share the opinion of Andrew Hunt and David Thomas, authors of the
great book "The Pragmatic Programmer". The opinion is, it is important to label files and
methods with author's name. So everybody knows who to ask, for the programmer to feel
more responsible for the code and last but not least to have something to be proud of!
> I'm not sure what the @version is about, but I would think it could it go
> to(?) I know that we don't have anything to look for it now. Is there some
> other kind of packager or something that looks for that?
The "@" tags are javadoc tags which are used by the "javadoc" tool which is used to
generate the automatic documentation system.
> [ if some kind of packager requires @author, then you could put "the
> Subversion team" or somesuch ]
>
> Cheers,
> -g
Alex
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: CVS update: ADDED: subversion/bindings/java/jni/org/tigris/subversion REMOVED: subversion/bindings/java/jni/org/tigris/subversion
Posted by Ben Collins-Sussman <su...@collab.net>.
Alexander Mueller <al...@littleblue.de> writes:
> > We normally do not attribute specific authors in the SVN
> > files. Personally, > I would be more comfortable to stick with that
> > precedent.
>
> Hmm. Personally I do share the opinion of Andrew Hunt and David
> Thomas, authors of the great book "The Pragmatic Programmer". The
> opinion is, it is important to label files and methods with author's
> name. So everybody knows who to ask, for the programmer to feel more
> responsible for the code and last but not least to have something to
> be proud of!
If you work on a certain section of code constantly, then your peers
are definitely aware! If there's any ever question as to who is
resposible for what, we have 'cvs log' and 'cvs annotate' to place the
blame^H^H^H^H^H praise. :-)
Besides, is it really going to make sense to have your name in there
in three years, when 5 people have come along and made gigantic
changes to the point that your original code is almost unrecognizable?
Labeling things like this just doesn't "groove" with the open source
ethic.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: CVS update: ADDED:
subversion/bindings/java/jni/org/tigris/subversion REMOVED:
subversion/bindings/java/jni/org/tigris/subversion
Posted by Alexander Mueller <al...@littleblue.de>.
cmpilato@collab.net schrieb:
> Alexander Mueller <al...@littleblue.de> writes:
>
> > Hmm. Personally I do share the opinion of Andrew Hunt and David
> > Thomas, authors of the great book "The Pragmatic Programmer". The
> > opinion is, it is important to label files and methods with author's
> > name. So everybody knows who to ask, for the programmer to feel more
> > responsible for the code and last but not least to have something to
> > be proud of!
>
> While I agree with the sentiment behind Hunt/Thomas' alleged
> statements, I think 'cvs annotate' (and soon, 'svn blame')
> accomplishes the task without violating the policies in place for this
> project.
but this way the comments are "only" in the repository. When I am offline with
my notebook; having a look at a file; no repository access. The I really
enjoy having comments in the file itself including as much information as
possible.
The file itself is one dimension, the repository information is another dimension.
Having access to both gives you all the information you need and
a "two dimensional" system.
Having no annotation in the file or wherever leaves you out in the rain.
But I guess this discussion is pretty philosophical and so the
opinions are quite personal...
>
>
> > The "@" tags are javadoc tags which are used by the "javadoc" tool
> > which is used to generate the automatic documentation system.
>
> Hee hee...I knew this one! I knew this one!
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
> For additional commands, e-mail: dev-help@subversion.tigris.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: CVS update: ADDED: subversion/bindings/java/jni/org/tigris/subversion REMOVED: subversion/bindings/java/jni/org/tigris/subversion
Posted by cm...@collab.net.
Alexander Mueller <al...@littleblue.de> writes:
> Hmm. Personally I do share the opinion of Andrew Hunt and David
> Thomas, authors of the great book "The Pragmatic Programmer". The
> opinion is, it is important to label files and methods with author's
> name. So everybody knows who to ask, for the programmer to feel more
> responsible for the code and last but not least to have something to
> be proud of!
While I agree with the sentiment behind Hunt/Thomas' alleged
statements, I think 'cvs annotate' (and soon, 'svn blame')
accomplishes the task without violating the policies in place for this
project.
> The "@" tags are javadoc tags which are used by the "javadoc" tool
> which is used to generate the automatic documentation system.
Hee hee...I knew this one! I knew this one!
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org