On 5/14/07, Gilles Scokart <[EMAIL PROTECTED]> wrote:
Concerning the use of the '_ : +1 to keep it. A few days ago, I was not a fan of it neither. However, after giving it a try in ivy code, I found that it rather good when it is used systematically. It makes the code slightly easier to understand (you identify more directly that a variable is a field), and more easy to write (no need to use 'this', code completion separates directly fields from other variables). Moreover, it is already used 'nearly' everywhere in the ivy code.
The main point is there, renaming every thing wouldn't be really easy. Now that I work both on projects using this convention and others using plain sun one, I'd say that I slightly prefer the pure sun conventions, mainly because everybody know them, and they do not require any special configuration in your IDE. For readibility it's now easy to configure IDE to see if a variable is local or an attribute. The only point I still see in favor of the _ is the affectation in constructors. So I'm +0 to keep it or remove it (due to the work induced) Concerning the @author tag :
+1 to remove it. I don't feel confortable with it. It is never clear what it means. It is never clear how it should be updated. Moreover, it is redundant with the svn history.
I'm ok to remove it, especially if somebody else than me can do it :-) Concerning the checkstyle instrcutions:
+1 to use it after a customisation (I din't look into the details yet, but it seems rather strict).
+1 too, but we should first conclude on the coding conventions before using it. Xavier --
Gilles SCOKART 2007/5/14, [EMAIL PROTECTED] <[EMAIL PROTECTED]>: > >> The sources I have seen seems to use the sun conventions > >(curly braces > >> on the same line than the class, function, if, for...). > >> > >> I also seen in some classes the use of _ for the class fields. > >> > >> Is it a coding conventions that should be followed, or is it just a > >> something used in some classes? > > > >I would strongly prefer that we get rid of the _ and stick to > >the Sun one. > >This is pretty common within the ASF and the standard by a wide margin. > > > >Notorious exception from the top of my head being Turbine, Maven and > >Apache DS which have a very annoying layout to me which affects > >readability for my stupid brain. > > > >Also the @author tag is now not used anymore across the asf code and > >should be removed. > > > >Generally speaking where possible, quality of code and javadoc should > >also be improved when you have the chance (ie: when you fix something, > >etc) as it will serve the project and also help it graduate > >since it is > >something that will be looked at attentively afaik. > > > I added a path on https://issues.apache.org/jira/browse/IVY-483 > containing > Checkstyle instructions coming from Ant. The checkstyle-config must be > adapted to Ivy's need. > > > Jan >
-- Xavier Hanin - Independent Java Consultant Manage your dependencies with Ivy! http://incubator.apache.org/ivy/
