----- Original Message -----
From: "Jari Worsley" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Wednesday, July 25, 2001 6:34 PM
Subject: Re: VOTE vs POLL + becoming a committer (WAS Re: [Cactus v2 - POLL]
Extension to web.xml mechanism)


> Vincent Massol wrote:
> >
> > Hola Alex,
>
> > >
> >
> > What you say is very true and I appreciate your openess on the subject.
> > However there is always risk when doing collaborative work. What is
> > important is adaptation : everyone need to adapt and be open. I will
need to
> > adapt to accept changes proposed by others, be in the code standard
>
> speaking of code standards, do we have/want/need any for cactus work?
> the style at the moment isn't Sun standard, shall we leave it like that
> or move to a standard? (because the best thing about standards is that
> there are so many of them to choose from ;)
>

I would tend to say that we would like to keep the existing standard. There
is only one place where I have changed idea and I think the code may not be
100% consistent. It is with the naming of class variables. Normally when I
write code, I always use "m_NameOfVariable" to differentiate it from local
variable. However, on the last project I worked on I had to conceded that we
would simply use the sun convention (i.e. just the name with no
differenciation) and I began to follow this convention when writing Cactus.
The fact is that I still prefer the "m_" one. I have to check but I think I
may have used both in Cactus. We'll just need to choose one and I'd like to
keep the rest. What we can do very quickly is put a web page on the cactus
web site to explain these conventions.

Very quickly :

1/ class brackets

public class MyClass
{

2/ method brackets

public void myMethdo()
{

3/ if, else, for brackets

if (xxx) {
} else if (yyy) {
} else {
}

4/ class variable Xxx : m_Xxx or xxx. To choose.

5/ method parameter Xxx : theXxx

ex: public void setName(String theClassName)

6/ Comments everywhere, including private methods and members

7/ @version @version@ in the class comment

8/ No @author tag, but we can change that (I wasn't putting any in the XP
fashion ...) if you wish.

9/ space after punctuation signs

ex1: if (x > 5)
ex2: x = x + 1;

10/ The rest following the Sun conventions!

I'd like to keep that and refrain from arguing too much on it ... I know
everyone has it's own preference but I also know that the arguing could go
on forever. We have a chance of having a code base that is already following
these rules (except maybe for point 4/ which we need to correct). Let's keep
it that way please ! :-)

Thanks
-Vincent

Reply via email to