You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by Sanjiva Weerawarana <sa...@opensource.lk> on 2007/01/30 05:28:18 UTC
coding conventions (was: Re: [Axis2] Issues with the current code
base)
On Mon, 2007-01-29 at 13:37 -0800, Bill Nagy wrote:
>
> I was unable to find them on the wiki (I looked at both the current as
> well as the old root pages.) The JAX-WS proposal only speaks in the
> abstract about code organization -- it says nothing about the formatting
> of Java source files. Certainly you can't expect people to adhere to
> coding guidelines that only appear in email messages from almost 2 years
> ago or even know that they exist in the first place.
Absolutely; fair enough.
The basic rule was that we're following the Sun Java coding conventions
(http://java.sun.com/docs/codeconv/) except for the number of columns
used. I argued hard for 80 col but was voted down .. we settled at 100,
which was the middle between 80 and 120 ;(.
Does anyone need more details? If not please conform.
(Old timers: if you remember the thread and can give a ref that maybe
useful.)
If someone volunteers to put this in the Wiki in big bold letters
that'll be great.
Thanks Bill for pushing this to closure!
Sanjiva.
p.s.: Don't take this to mean that only new folks are guilty of
violating the conventions .. everyone is :(. But we need to try to do
better .. and its easier to get folks to get in line as they start
rather than later. Still, if you find offenders please jump on them! (In
a nice warm, fuzzy kinda way ;-))
--
Sanjiva Weerawarana, Ph.D.
Founder & Director; Lanka Software Foundation; http://www.opensource.lk/
Founder, Chairman & CEO; WSO2, Inc.; http://www.wso2.com/
Director; Open Source Initiative; http://www.opensource.org/
Member; Apache Software Foundation; http://www.apache.org/
Visiting Lecturer; University of Moratuwa; http://www.cse.mrt.ac.lk/
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-dev-help@ws.apache.org
Re: [AXIS2] coding conventions
Posted by Eran Chinthaka <ch...@opensource.lk>.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Sanjiva Weerawarana wrote:
> Absolutely; fair enough.
>
> The basic rule was that we're following the Sun Java coding conventions
> (http://java.sun.com/docs/codeconv/) except for the number of columns
> used. I argued hard for 80 col but was voted down .. we settled at 100,
> which was the middle between 80 and 120 ;(.
>
> Does anyone need more details? If not please conform.
>
> (Old timers:
I don't think a young kid like me will fall in to this category :)
> if you remember the thread and can give a ref that maybe
> useful.)
>
This [1] is one of the threads we discussed about coding conventions
long time back. We were talking about places to put the code guide
lines, but no one put it. But the thread had concluded with Venkat
mentioning about keeping java coding conventions as a minimum.
Anyway, I thought, may be I am wrong, that in a java project, java
coding conventions are implicit, unless stated otherwise.
Since I felt guilty for not creating a page, even being part of the
initial discussion, I created an initial page for coding conventions
here [2]. Please feel free to edit it.
One more note. We all do mistakes in the code. At least, I do mistakes
however much I tried. Please feel free to correct them, if you see them.
And this will help to improve the quality of "our" code.
- -- Chinthaka
[1] : http://marc.theaimsgroup.com/?l=axis-dev&m=112102728201670&w=2
[2] : http://wiki.apache.org/ws/FrontPage/Axis2/Code-Conventions
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.3 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
iD8DBQFFvtSijON2uBzUhh8RAgvGAJ4yIugFZvrxaN8LdP9EWZSajgj8LgCghE6x
Dz0IQBgDw1DgJDjoOpf7zHE=
=lXEz
-----END PGP SIGNATURE-----
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-dev-help@ws.apache.org
Re: coding conventions (was: Re: [Axis2] Issues with the current code base)
Posted by Thilina Gunarathne <cs...@gmail.com>.
HI all,
We already have a document which talks about the code quality [1]. We
can add whatever more details in to there.. We also need a BIG BOLD
lettered link to this page..
We have earlier agreed on using java coding conventions.. But IMHO
It's always implied that a java developer will adhere to those. Also
coding conventions is important thing we *MUST* be looking at when we
are voting somebody as a committer. That's why we need to look at a
considerable number of commits before proposing somebody as a
committer.. (Of course this does not apply to doc committers)..
We can add these to the http://ws.apache.org/axis2/guidelines.html
document as discussed in this thread [2].
~Thilina
[1] http://wiki.apache.org/ws/FrontPage/Axis2/CodeQuality
[2] http://marc.theaimsgroup.com/?l=axis-dev&m=112115920228742&w=2
On 1/30/07, Sanjiva Weerawarana <sa...@opensource.lk> wrote:
> On Mon, 2007-01-29 at 13:37 -0800, Bill Nagy wrote:
> >
> > I was unable to find them on the wiki (I looked at both the current as
> > well as the old root pages.) The JAX-WS proposal only speaks in the
> > abstract about code organization -- it says nothing about the formatting
> > of Java source files. Certainly you can't expect people to adhere to
> > coding guidelines that only appear in email messages from almost 2 years
> > ago or even know that they exist in the first place.
>
> Absolutely; fair enough.
>
> The basic rule was that we're following the Sun Java coding conventions
> (http://java.sun.com/docs/codeconv/) except for the number of columns
> used. I argued hard for 80 col but was voted down .. we settled at 100,
> which was the middle between 80 and 120 ;(.
>
> Does anyone need more details? If not please conform.
>
> (Old timers: if you remember the thread and can give a ref that maybe
> useful.)
>
> If someone volunteers to put this in the Wiki in big bold letters
> that'll be great.
>
> Thanks Bill for pushing this to closure!
>
> Sanjiva.
> p.s.: Don't take this to mean that only new folks are guilty of
> violating the conventions .. everyone is :(. But we need to try to do
> better .. and its easier to get folks to get in line as they start
> rather than later. Still, if you find offenders please jump on them! (In
> a nice warm, fuzzy kinda way ;-))
> --
> Sanjiva Weerawarana, Ph.D.
> Founder & Director; Lanka Software Foundation; http://www.opensource.lk/
> Founder, Chairman & CEO; WSO2, Inc.; http://www.wso2.com/
> Director; Open Source Initiative; http://www.opensource.org/
> Member; Apache Software Foundation; http://www.apache.org/
> Visiting Lecturer; University of Moratuwa; http://www.cse.mrt.ac.lk/
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
> For additional commands, e-mail: axis-dev-help@ws.apache.org
>
>
--
Thilina Gunarathne
WSO2, Inc.; http://www.wso2.com/
Home page: http://webservices.apache.org/~thilina/
Blog: http://thilinag.blogspot.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-dev-help@ws.apache.org
Re: [Axis2] coding conventions
Posted by Eran Chinthaka <ch...@opensource.lk>.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Ohh, I'm sorry we have it before. Let's scrap the new one, I just created.
See who had edited it last, on 2005-12-13 15:46:03 :)
- -- Chinthaka
Ruchith Fernando wrote:
> FYI : http://wiki.apache.org/ws/FrontPage/Axis2/CodeQuality
>
> Thanks,
> Ruchith
>
> On 1/30/07, Sanjiva Weerawarana <sa...@opensource.lk> wrote:
>> On Mon, 2007-01-29 at 13:37 -0800, Bill Nagy wrote:
>> >
>> > I was unable to find them on the wiki (I looked at both the current as
>> > well as the old root pages.) The JAX-WS proposal only speaks in the
>> > abstract about code organization -- it says nothing about the
>> formatting
>> > of Java source files. Certainly you can't expect people to adhere to
>> > coding guidelines that only appear in email messages from almost 2
>> years
>> > ago or even know that they exist in the first place.
>>
>> Absolutely; fair enough.
>>
>> The basic rule was that we're following the Sun Java coding conventions
>> (http://java.sun.com/docs/codeconv/) except for the number of columns
>> used. I argued hard for 80 col but was voted down .. we settled at 100,
>> which was the middle between 80 and 120 ;(.
>>
>> Does anyone need more details? If not please conform.
>>
>> (Old timers: if you remember the thread and can give a ref that maybe
>> useful.)
>>
>> If someone volunteers to put this in the Wiki in big bold letters
>> that'll be great.
>>
>> Thanks Bill for pushing this to closure!
>>
>> Sanjiva.
>> p.s.: Don't take this to mean that only new folks are guilty of
>> violating the conventions .. everyone is :(. But we need to try to do
>> better .. and its easier to get folks to get in line as they start
>> rather than later. Still, if you find offenders please jump on them! (In
>> a nice warm, fuzzy kinda way ;-))
>> --
>> Sanjiva Weerawarana, Ph.D.
>> Founder & Director; Lanka Software Foundation; http://www.opensource.lk/
>> Founder, Chairman & CEO; WSO2, Inc.; http://www.wso2.com/
>> Director; Open Source Initiative; http://www.opensource.org/
>> Member; Apache Software Foundation; http://www.apache.org/
>> Visiting Lecturer; University of Moratuwa; http://www.cse.mrt.ac.lk/
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
>> For additional commands, e-mail: axis-dev-help@ws.apache.org
>>
>>
>
>
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.3 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
iD8DBQFFvtY1jON2uBzUhh8RAt0TAJ92+rDU8SMg1AoqyKx/l6QZ3J2w6wCeM8c9
gXqhD+McyoFdX5f22jHoh+Q=
=Or+2
-----END PGP SIGNATURE-----
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-dev-help@ws.apache.org
Re: coding conventions (was: Re: [Axis2] Issues with the current code base)
Posted by Ruchith Fernando <ru...@gmail.com>.
FYI : http://wiki.apache.org/ws/FrontPage/Axis2/CodeQuality
Thanks,
Ruchith
On 1/30/07, Sanjiva Weerawarana <sa...@opensource.lk> wrote:
> On Mon, 2007-01-29 at 13:37 -0800, Bill Nagy wrote:
> >
> > I was unable to find them on the wiki (I looked at both the current as
> > well as the old root pages.) The JAX-WS proposal only speaks in the
> > abstract about code organization -- it says nothing about the formatting
> > of Java source files. Certainly you can't expect people to adhere to
> > coding guidelines that only appear in email messages from almost 2 years
> > ago or even know that they exist in the first place.
>
> Absolutely; fair enough.
>
> The basic rule was that we're following the Sun Java coding conventions
> (http://java.sun.com/docs/codeconv/) except for the number of columns
> used. I argued hard for 80 col but was voted down .. we settled at 100,
> which was the middle between 80 and 120 ;(.
>
> Does anyone need more details? If not please conform.
>
> (Old timers: if you remember the thread and can give a ref that maybe
> useful.)
>
> If someone volunteers to put this in the Wiki in big bold letters
> that'll be great.
>
> Thanks Bill for pushing this to closure!
>
> Sanjiva.
> p.s.: Don't take this to mean that only new folks are guilty of
> violating the conventions .. everyone is :(. But we need to try to do
> better .. and its easier to get folks to get in line as they start
> rather than later. Still, if you find offenders please jump on them! (In
> a nice warm, fuzzy kinda way ;-))
> --
> Sanjiva Weerawarana, Ph.D.
> Founder & Director; Lanka Software Foundation; http://www.opensource.lk/
> Founder, Chairman & CEO; WSO2, Inc.; http://www.wso2.com/
> Director; Open Source Initiative; http://www.opensource.org/
> Member; Apache Software Foundation; http://www.apache.org/
> Visiting Lecturer; University of Moratuwa; http://www.cse.mrt.ac.lk/
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
> For additional commands, e-mail: axis-dev-help@ws.apache.org
>
>
--
www.ruchith.org
www.wso2.org
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-dev-help@ws.apache.org