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 Eran Chinthaka <ch...@opensource.lk> on 2005/07/10 16:28:28 UTC
RE: [axis2] Code commentary
Hi Glen and all,
>
> Hi folks!
>
> I'm re-ramping up on the current state of Axis2, and hoping to dive in
> for some substantive coding work in the next few days (some work on
> modules and looking into RPC/enc). As I'm going through the code, I
> notice a few things:
>
> * Formatting inconsistencies all over the place... can we run the whole
> codebase through IDEA's "reformat code" tool? (+1 from me!)
+1 from me too. If some one can setup his IDE and save the code template and
send to us, that will be easy to share the same code style. So for others we
can enforce that by asking to put that template in the {IDEA_HOME}
\config\codestyles folder.
Sorry I can not volunteer to this as I'm bit uncertain about some coding
styles. But if some one lays down them here, I can help :).
>
> * We decided on either 80 or 100 char lines back in December (seach the
> archives for "80 columns"), and yet there are a lot of lines > 120 chars.
>
> * Lack of comments. It is really important to have at least some notion
> of what each class is for, and ideally a good explanation, in the
> JavaDoc header for that class (ditto for methods). Lots of our current
> classes/methods are missing any comments.
Will do this. I also need some time to do it.
Regards,
Chinthaka
>
> Can folks try to rectify these things as we continue to work in various
> places?
>
> Thanks,
> --Glen
>
> P.S. I'm super-pleased at the speed and size so far!! Nice job!
>
Re: [axis2] Code commentary
Posted by jayachandra <ja...@gmail.com>.
+1 for 80 column lines. Many linux guys out there will curse us otherwise ;)
On 7/11/05, Sanjiva Weerawarana <sa...@opensource.lk> wrote:
> +1 for 80 columns! Let's have that vote again .. I sense my side may win
> this time ;-).
>
> I hate not being able to open files in vi in my 80 column shell too.
>
> Sanjiva.
>
> On Mon, 2005-07-11 at 13:00 +0530, Venkat Reddy wrote:
> > On 7/11/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> > > Hi,
> > >
> > > >
> > > > For those who use Eclipse, it is as simple as right-clicking on the
> > > > package or class and select "Source >> Format". The Eclipse bilt-in
> > > > template will be applied. I think we can agree on the eclipse defalut
> > > > template (also exported and attached here) for code, which also agrees
> > > > with standard Java code conventions.
> > >
> > > I didn't see line length as 100 in the attached template. I think it was 80.
> >
> > Why not not just follow the standard convention
> > (http://java.sun.com/docs/codeconv/html/CodeConventions.doc3.html#313)?
> > It will save time in having our own formatter, if we just follow the
> > default language standards. (Whats the default IDEA template?).
> > Ofcourse, unless we have a specific need to have 100 rather than 80.
> >
> > >
> > > >
> > > > btw, whats most popular IDE for Axis dev community? :-) I'm a big fan
> > > > of Eclipse.
> > >
> > > Popularity does not make sense and has zero information. Individual
> > > convenience is what that matters ;).
> > >
> > > Hope we will not gonna start the Eclipse vs Idea war here :).
> >
> > Nope, its not say something is better, but I think its worth talking
> > about unless you want to maintain top secrecy about your IDE :-) and
> > we already talking about IDEA, isn't it?
> >
> > >
> > > -- Chinthaka
> > >
> > > >
> > > > -venkat
> > > >
> > > >
> > > >
> > > > On 7/10/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> > > > > Hi Glen and all,
> > > > >
> > > > > >
> > > > > > Hi folks!
> > > > > >
> > > > > > I'm re-ramping up on the current state of Axis2, and hoping to dive in
> > > > > > for some substantive coding work in the next few days (some work on
> > > > > > modules and looking into RPC/enc). As I'm going through the code, I
> > > > > > notice a few things:
> > > > > >
> > > > > > * Formatting inconsistencies all over the place... can we run the
> > > > whole
> > > > > > codebase through IDEA's "reformat code" tool? (+1 from me!)
> > > > >
> > > > > +1 from me too. If some one can setup his IDE and save the code template
> > > > and
> > > > > send to us, that will be easy to share the same code style. So for
> > > > others we
> > > > > can enforce that by asking to put that template in the {IDEA_HOME}
> > > > > \config\codestyles folder.
> > > > >
> > > > > Sorry I can not volunteer to this as I'm bit uncertain about some coding
> > > > > styles. But if some one lays down them here, I can help :).
> > > > >
> > > > > >
> > > > > > * We decided on either 80 or 100 char lines back in December (seach
> > > > the
> > > > > > archives for "80 columns"), and yet there are a lot of lines > 120
> > > > chars.
> > > > > >
> > > > > > * Lack of comments. It is really important to have at least some
> > > > notion
> > > > > > of what each class is for, and ideally a good explanation, in the
> > > > > > JavaDoc header for that class (ditto for methods). Lots of our
> > > > current
> > > > > > classes/methods are missing any comments.
> > > > >
> > > > > Will do this. I also need some time to do it.
> > > > >
> > > > > Regards,
> > > > > Chinthaka
> > > > >
> > > > > >
> > > > > > Can folks try to rectify these things as we continue to work in
> > > > various
> > > > > > places?
> > > > > >
> > > > > > Thanks,
> > > > > > --Glen
> > > > > >
> > > > > > P.S. I'm super-pleased at the speed and size so far!! Nice job!
> > > > > >
> > > > >
> > > > >
> > > > >
> > > > >
> > >
> > >
> > >
> >
>
>
--
-- Jaya
Re: [axis2] Code commentary
Posted by Sanjiva Weerawarana <sa...@opensource.lk>.
+1 for 80 columns! Let's have that vote again .. I sense my side may win
this time ;-).
I hate not being able to open files in vi in my 80 column shell too.
Sanjiva.
On Mon, 2005-07-11 at 13:00 +0530, Venkat Reddy wrote:
> On 7/11/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> > Hi,
> >
> > >
> > > For those who use Eclipse, it is as simple as right-clicking on the
> > > package or class and select "Source >> Format". The Eclipse bilt-in
> > > template will be applied. I think we can agree on the eclipse defalut
> > > template (also exported and attached here) for code, which also agrees
> > > with standard Java code conventions.
> >
> > I didn't see line length as 100 in the attached template. I think it was 80.
>
> Why not not just follow the standard convention
> (http://java.sun.com/docs/codeconv/html/CodeConventions.doc3.html#313)?
> It will save time in having our own formatter, if we just follow the
> default language standards. (Whats the default IDEA template?).
> Ofcourse, unless we have a specific need to have 100 rather than 80.
>
> >
> > >
> > > btw, whats most popular IDE for Axis dev community? :-) I'm a big fan
> > > of Eclipse.
> >
> > Popularity does not make sense and has zero information. Individual
> > convenience is what that matters ;).
> >
> > Hope we will not gonna start the Eclipse vs Idea war here :).
>
> Nope, its not say something is better, but I think its worth talking
> about unless you want to maintain top secrecy about your IDE :-) and
> we already talking about IDEA, isn't it?
>
> >
> > -- Chinthaka
> >
> > >
> > > -venkat
> > >
> > >
> > >
> > > On 7/10/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> > > > Hi Glen and all,
> > > >
> > > > >
> > > > > Hi folks!
> > > > >
> > > > > I'm re-ramping up on the current state of Axis2, and hoping to dive in
> > > > > for some substantive coding work in the next few days (some work on
> > > > > modules and looking into RPC/enc). As I'm going through the code, I
> > > > > notice a few things:
> > > > >
> > > > > * Formatting inconsistencies all over the place... can we run the
> > > whole
> > > > > codebase through IDEA's "reformat code" tool? (+1 from me!)
> > > >
> > > > +1 from me too. If some one can setup his IDE and save the code template
> > > and
> > > > send to us, that will be easy to share the same code style. So for
> > > others we
> > > > can enforce that by asking to put that template in the {IDEA_HOME}
> > > > \config\codestyles folder.
> > > >
> > > > Sorry I can not volunteer to this as I'm bit uncertain about some coding
> > > > styles. But if some one lays down them here, I can help :).
> > > >
> > > > >
> > > > > * We decided on either 80 or 100 char lines back in December (seach
> > > the
> > > > > archives for "80 columns"), and yet there are a lot of lines > 120
> > > chars.
> > > > >
> > > > > * Lack of comments. It is really important to have at least some
> > > notion
> > > > > of what each class is for, and ideally a good explanation, in the
> > > > > JavaDoc header for that class (ditto for methods). Lots of our
> > > current
> > > > > classes/methods are missing any comments.
> > > >
> > > > Will do this. I also need some time to do it.
> > > >
> > > > Regards,
> > > > Chinthaka
> > > >
> > > > >
> > > > > Can folks try to rectify these things as we continue to work in
> > > various
> > > > > places?
> > > > >
> > > > > Thanks,
> > > > > --Glen
> > > > >
> > > > > P.S. I'm super-pleased at the speed and size so far!! Nice job!
> > > > >
> > > >
> > > >
> > > >
> > > >
> >
> >
> >
>
Re: [axis2] Code commentary
Posted by Venkat Reddy <vr...@gmail.com>.
On 7/11/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> Hi,
>
> >
> > For those who use Eclipse, it is as simple as right-clicking on the
> > package or class and select "Source >> Format". The Eclipse bilt-in
> > template will be applied. I think we can agree on the eclipse defalut
> > template (also exported and attached here) for code, which also agrees
> > with standard Java code conventions.
>
> I didn't see line length as 100 in the attached template. I think it was 80.
Why not not just follow the standard convention
(http://java.sun.com/docs/codeconv/html/CodeConventions.doc3.html#313)?
It will save time in having our own formatter, if we just follow the
default language standards. (Whats the default IDEA template?).
Ofcourse, unless we have a specific need to have 100 rather than 80.
>
> >
> > btw, whats most popular IDE for Axis dev community? :-) I'm a big fan
> > of Eclipse.
>
> Popularity does not make sense and has zero information. Individual
> convenience is what that matters ;).
>
> Hope we will not gonna start the Eclipse vs Idea war here :).
Nope, its not say something is better, but I think its worth talking
about unless you want to maintain top secrecy about your IDE :-) and
we already talking about IDEA, isn't it?
>
> -- Chinthaka
>
> >
> > -venkat
> >
> >
> >
> > On 7/10/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> > > Hi Glen and all,
> > >
> > > >
> > > > Hi folks!
> > > >
> > > > I'm re-ramping up on the current state of Axis2, and hoping to dive in
> > > > for some substantive coding work in the next few days (some work on
> > > > modules and looking into RPC/enc). As I'm going through the code, I
> > > > notice a few things:
> > > >
> > > > * Formatting inconsistencies all over the place... can we run the
> > whole
> > > > codebase through IDEA's "reformat code" tool? (+1 from me!)
> > >
> > > +1 from me too. If some one can setup his IDE and save the code template
> > and
> > > send to us, that will be easy to share the same code style. So for
> > others we
> > > can enforce that by asking to put that template in the {IDEA_HOME}
> > > \config\codestyles folder.
> > >
> > > Sorry I can not volunteer to this as I'm bit uncertain about some coding
> > > styles. But if some one lays down them here, I can help :).
> > >
> > > >
> > > > * We decided on either 80 or 100 char lines back in December (seach
> > the
> > > > archives for "80 columns"), and yet there are a lot of lines > 120
> > chars.
> > > >
> > > > * Lack of comments. It is really important to have at least some
> > notion
> > > > of what each class is for, and ideally a good explanation, in the
> > > > JavaDoc header for that class (ditto for methods). Lots of our
> > current
> > > > classes/methods are missing any comments.
> > >
> > > Will do this. I also need some time to do it.
> > >
> > > Regards,
> > > Chinthaka
> > >
> > > >
> > > > Can folks try to rectify these things as we continue to work in
> > various
> > > > places?
> > > >
> > > > Thanks,
> > > > --Glen
> > > >
> > > > P.S. I'm super-pleased at the speed and size so far!! Nice job!
> > > >
> > >
> > >
> > >
> > >
>
>
>
Re: [axis2] Code commentary
Posted by Venkat Reddy <vr...@gmail.com>.
To start with, our coding convntions can just mention the exceptions
or customizations to the official Sun Java Coding Conventions at
http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html.
I'm +1 for adapting it without changes.
-- venkat
On 7/12/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> Current Guidelines page only contains mails guidelines, which I steel from
> axis 1.x site. I think it's better to put our coding guidelines also there
> under a separate heading.
>
> And I'd like to see that information appearing in the distribution too.
>
> -- Chinthaka
> > -----Original Message-----
> > From: Glen Daniels [mailto:glen@thoughtcraft.com]
> > Sent: Monday, July 11, 2005 11:34 PM
> > To: axis-dev@ws.apache.org
> > Subject: RE: [axis2] Code commentary
> >
> >
> > OK, folks, I just did the reformat (using IDEA). I actually did it twice,
> > once without line-wrapping changes and once with. If
> > there are any issues/problems feel free to roll it back, but at first
> > glance it looks fine to me.
> >
> > Thilina, I completely agree we should have coding conventions listed in a
> > public place. Should we put them in
> > http://ws.apache.org/axis2/guidelines.html, or should we actually put a
> > file in the distribution itself? I'm thinking the latter
> > might be nice, something like java/contributing.html which could contain
> > info on mailing lists, committership, coding standards,
> > etc....
> >
> > --Glen
> >
> > > -----Original Message-----
> > > From: Thilina Gunarathne [mailto:csethil@gmail.com]
> > > Sent: Monday, July 11, 2005 3:03 AM
> > > To: axis-dev@ws.apache.org
> > > Subject: Re: [axis2] Code commentary
> > >
> > > Hi all,
> > >
> > > >>We decided on either 80 or 100 char lines back in December
> > > (seach the
> > > >>archives for "80 columns"),
> > >
> > > I got involved with Axis2 only after last December. I got to
> > > know this decision only from this thread. Also earlier this
> > > month I got to know that we have agreed to use American
> > > English for spellings.
> > >
> > > I feel it's better to have these decisions regarding to Code
> > > Styles that we use in Axis2 documented in somewhere, so that
> > > the new Commiters like me can take benefit of them. It'll be
> > > a good guide to new Commiters and also it'll help to improve
> > > the code quality of Axis2.
> > >
> > > Thanks & Regards,
> > > ~Thilina
> > >
> > >
> > > On 7/11/05, Venkat Reddy <vr...@gmail.com> wrote:
> > >
> > > For those who use Eclipse, it is as simple as
> > > right-clicking on the
> > > package or class and select "Source >> Format". The
> > > Eclipse bilt-in
> > > template will be applied. I think we can agree on the
> > > eclipse defalut
> > > template (also exported and attached here) for code,
> > > which also agrees
> > > with standard Java code conventions.
> > >
> > > btw, whats most popular IDE for Axis dev community? :-)
> > > I'm a big fan
> > > of Eclipse.
> > >
> > > -venkat
> > >
> > >
> > >
> > > On 7/10/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> > > > Hi Glen and all,
> > > >
> > > > >
> > > > > Hi folks!
> > > > >
> > > > > I'm re-ramping up on the current state of Axis2,
> > > and hoping to dive in
> > > > > for some substantive coding work in the next few
> > > days (some work on
> > > > > modules and looking into RPC/enc). As I'm going
> > > through the code, I
> > > > > notice a few things:
> > > > >
> > > > > * Formatting inconsistencies all over the place...
> > > can we run the whole
> > > > > codebase through IDEA's "reformat code" tool? (+1 from me!)
> > > >
> > > > +1 from me too. If some one can setup his IDE and
> > > save the code template and
> > > > send to us, that will be easy to share the same code
> > > style. So for others we
> > > > can enforce that by asking to put that template in
> > > the {IDEA_HOME}
> > > > \config\codestyles folder.
> > > >
> > > > Sorry I can not volunteer to this as I'm bit
> > > uncertain about some coding
> > > > styles. But if some one lays down them here, I can help :).
> > > >
> > > > >
> > > > > * We decided on either 80 or 100 char lines back in
> > > December (seach the
> > > > > archives for "80 columns"), and yet there are a lot
> > > of lines > 120 chars.
> > > > >
> > > > > * Lack of comments. It is really important to have
> > > at least some notion
> > > > > of what each class is for, and ideally a good
> > > explanation, in the
> > > > > JavaDoc header for that class (ditto for methods).
> > > Lots of our current
> > > > > classes/methods are missing any comments.
> > > >
> > > > Will do this. I also need some time to do it.
> > > >
> > > > Regards,
> > > > Chinthaka
> > > >
> > > > >
> > > > > Can folks try to rectify these things as we
> > > continue to work in various
> > > > > places?
> > > > >
> > > > > Thanks,
> > > > > --Glen
> > > > >
> > > > > P.S. I'm super-pleased at the speed and size so
> > > far!! Nice job!
> > > > >
> > > >
> > > >
> > > >
> > > >
> > >
> > >
> > >
> > >
> > >
> > > "May the SourcE be with u"
> > > http://www.bloglines.com/blog/thilina
> > > <http://www.bloglines.com/blog/thilina>
> > >
>
>
>
>
RE: [axis2] Code commentary
Posted by Eran Chinthaka <ch...@opensource.lk>.
Current Guidelines page only contains mails guidelines, which I steel from
axis 1.x site. I think it's better to put our coding guidelines also there
under a separate heading.
And I'd like to see that information appearing in the distribution too.
-- Chinthaka
> -----Original Message-----
> From: Glen Daniels [mailto:glen@thoughtcraft.com]
> Sent: Monday, July 11, 2005 11:34 PM
> To: axis-dev@ws.apache.org
> Subject: RE: [axis2] Code commentary
>
>
> OK, folks, I just did the reformat (using IDEA). I actually did it twice,
> once without line-wrapping changes and once with. If
> there are any issues/problems feel free to roll it back, but at first
> glance it looks fine to me.
>
> Thilina, I completely agree we should have coding conventions listed in a
> public place. Should we put them in
> http://ws.apache.org/axis2/guidelines.html, or should we actually put a
> file in the distribution itself? I'm thinking the latter
> might be nice, something like java/contributing.html which could contain
> info on mailing lists, committership, coding standards,
> etc....
>
> --Glen
>
> > -----Original Message-----
> > From: Thilina Gunarathne [mailto:csethil@gmail.com]
> > Sent: Monday, July 11, 2005 3:03 AM
> > To: axis-dev@ws.apache.org
> > Subject: Re: [axis2] Code commentary
> >
> > Hi all,
> >
> > >>We decided on either 80 or 100 char lines back in December
> > (seach the
> > >>archives for "80 columns"),
> >
> > I got involved with Axis2 only after last December. I got to
> > know this decision only from this thread. Also earlier this
> > month I got to know that we have agreed to use American
> > English for spellings.
> >
> > I feel it's better to have these decisions regarding to Code
> > Styles that we use in Axis2 documented in somewhere, so that
> > the new Commiters like me can take benefit of them. It'll be
> > a good guide to new Commiters and also it'll help to improve
> > the code quality of Axis2.
> >
> > Thanks & Regards,
> > ~Thilina
> >
> >
> > On 7/11/05, Venkat Reddy <vr...@gmail.com> wrote:
> >
> > For those who use Eclipse, it is as simple as
> > right-clicking on the
> > package or class and select "Source >> Format". The
> > Eclipse bilt-in
> > template will be applied. I think we can agree on the
> > eclipse defalut
> > template (also exported and attached here) for code,
> > which also agrees
> > with standard Java code conventions.
> >
> > btw, whats most popular IDE for Axis dev community? :-)
> > I'm a big fan
> > of Eclipse.
> >
> > -venkat
> >
> >
> >
> > On 7/10/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> > > Hi Glen and all,
> > >
> > > >
> > > > Hi folks!
> > > >
> > > > I'm re-ramping up on the current state of Axis2,
> > and hoping to dive in
> > > > for some substantive coding work in the next few
> > days (some work on
> > > > modules and looking into RPC/enc). As I'm going
> > through the code, I
> > > > notice a few things:
> > > >
> > > > * Formatting inconsistencies all over the place...
> > can we run the whole
> > > > codebase through IDEA's "reformat code" tool? (+1 from me!)
> > >
> > > +1 from me too. If some one can setup his IDE and
> > save the code template and
> > > send to us, that will be easy to share the same code
> > style. So for others we
> > > can enforce that by asking to put that template in
> > the {IDEA_HOME}
> > > \config\codestyles folder.
> > >
> > > Sorry I can not volunteer to this as I'm bit
> > uncertain about some coding
> > > styles. But if some one lays down them here, I can help :).
> > >
> > > >
> > > > * We decided on either 80 or 100 char lines back in
> > December (seach the
> > > > archives for "80 columns"), and yet there are a lot
> > of lines > 120 chars.
> > > >
> > > > * Lack of comments. It is really important to have
> > at least some notion
> > > > of what each class is for, and ideally a good
> > explanation, in the
> > > > JavaDoc header for that class (ditto for methods).
> > Lots of our current
> > > > classes/methods are missing any comments.
> > >
> > > Will do this. I also need some time to do it.
> > >
> > > Regards,
> > > Chinthaka
> > >
> > > >
> > > > Can folks try to rectify these things as we
> > continue to work in various
> > > > places?
> > > >
> > > > Thanks,
> > > > --Glen
> > > >
> > > > P.S. I'm super-pleased at the speed and size so
> > far!! Nice job!
> > > >
> > >
> > >
> > >
> > >
> >
> >
> >
> >
> >
> > "May the SourcE be with u"
> > http://www.bloglines.com/blog/thilina
> > <http://www.bloglines.com/blog/thilina>
> >
RE: [axis2] Code commentary
Posted by Glen Daniels <gl...@thoughtcraft.com>.
OK, folks, I just did the reformat (using IDEA). I actually did it twice, once without line-wrapping changes and once with. If
there are any issues/problems feel free to roll it back, but at first glance it looks fine to me.
Thilina, I completely agree we should have coding conventions listed in a public place. Should we put them in
http://ws.apache.org/axis2/guidelines.html, or should we actually put a file in the distribution itself? I'm thinking the latter
might be nice, something like java/contributing.html which could contain info on mailing lists, committership, coding standards,
etc....
--Glen
> -----Original Message-----
> From: Thilina Gunarathne [mailto:csethil@gmail.com]
> Sent: Monday, July 11, 2005 3:03 AM
> To: axis-dev@ws.apache.org
> Subject: Re: [axis2] Code commentary
>
> Hi all,
>
> >>We decided on either 80 or 100 char lines back in December
> (seach the
> >>archives for "80 columns"),
>
> I got involved with Axis2 only after last December. I got to
> know this decision only from this thread. Also earlier this
> month I got to know that we have agreed to use American
> English for spellings.
>
> I feel it's better to have these decisions regarding to Code
> Styles that we use in Axis2 documented in somewhere, so that
> the new Commiters like me can take benefit of them. It'll be
> a good guide to new Commiters and also it'll help to improve
> the code quality of Axis2.
>
> Thanks & Regards,
> ~Thilina
>
>
> On 7/11/05, Venkat Reddy <vr...@gmail.com> wrote:
>
> For those who use Eclipse, it is as simple as
> right-clicking on the
> package or class and select "Source >> Format". The
> Eclipse bilt-in
> template will be applied. I think we can agree on the
> eclipse defalut
> template (also exported and attached here) for code,
> which also agrees
> with standard Java code conventions.
>
> btw, whats most popular IDE for Axis dev community? :-)
> I'm a big fan
> of Eclipse.
>
> -venkat
>
>
>
> On 7/10/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> > Hi Glen and all,
> >
> > >
> > > Hi folks!
> > >
> > > I'm re-ramping up on the current state of Axis2,
> and hoping to dive in
> > > for some substantive coding work in the next few
> days (some work on
> > > modules and looking into RPC/enc). As I'm going
> through the code, I
> > > notice a few things:
> > >
> > > * Formatting inconsistencies all over the place...
> can we run the whole
> > > codebase through IDEA's "reformat code" tool? (+1 from me!)
> >
> > +1 from me too. If some one can setup his IDE and
> save the code template and
> > send to us, that will be easy to share the same code
> style. So for others we
> > can enforce that by asking to put that template in
> the {IDEA_HOME}
> > \config\codestyles folder.
> >
> > Sorry I can not volunteer to this as I'm bit
> uncertain about some coding
> > styles. But if some one lays down them here, I can help :).
> >
> > >
> > > * We decided on either 80 or 100 char lines back in
> December (seach the
> > > archives for "80 columns"), and yet there are a lot
> of lines > 120 chars.
> > >
> > > * Lack of comments. It is really important to have
> at least some notion
> > > of what each class is for, and ideally a good
> explanation, in the
> > > JavaDoc header for that class (ditto for methods).
> Lots of our current
> > > classes/methods are missing any comments.
> >
> > Will do this. I also need some time to do it.
> >
> > Regards,
> > Chinthaka
> >
> > >
> > > Can folks try to rectify these things as we
> continue to work in various
> > > places?
> > >
> > > Thanks,
> > > --Glen
> > >
> > > P.S. I'm super-pleased at the speed and size so
> far!! Nice job!
> > >
> >
> >
> >
> >
>
>
>
>
>
> "May the SourcE be with u"
> http://www.bloglines.com/blog/thilina
> <http://www.bloglines.com/blog/thilina>
>
Re: [axis2] Code commentary
Posted by Thilina Gunarathne <cs...@gmail.com>.
Hi all,
>>We decided on either 80 or 100 char lines back in December (seach the
>>archives for "80 columns"),
I got involved with Axis2 only after last December. I got to know this
decision only from this thread. Also earlier this month I got to know that
we have agreed to use American English for spellings.
I feel it's better to have these decisions regarding to Code Styles that we
use in Axis2 documented in somewhere, so that the new Commiters like me can
take benefit of them. It'll be a good guide to new Commiters and also it'll
help to improve the code quality of Axis2.
Thanks & Regards,
~Thilina
On 7/11/05, Venkat Reddy <vr...@gmail.com> wrote:
> For those who use Eclipse, it is as simple as right-clicking on the
> package or class and select "Source >> Format". The Eclipse bilt-in
> template will be applied. I think we can agree on the eclipse defalut
> template (also exported and attached here) for code, which also agrees
> with standard Java code conventions.
>
> btw, whats most popular IDE for Axis dev community? :-) I'm a big fan
> of Eclipse.
>
> -venkat
>
>
>
> On 7/10/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> > Hi Glen and all,
> >
> > >
> > > Hi folks!
> > >
> > > I'm re-ramping up on the current state of Axis2, and hoping to dive in
> > > for some substantive coding work in the next few days (some work on
> > > modules and looking into RPC/enc). As I'm going through the code, I
> > > notice a few things:
> > >
> > > * Formatting inconsistencies all over the place... can we run the
> whole
> > > codebase through IDEA's "reformat code" tool? (+1 from me!)
> >
> > +1 from me too. If some one can setup his IDE and save the code template
> and
> > send to us, that will be easy to share the same code style. So for
> others we
> > can enforce that by asking to put that template in the {IDEA_HOME}
> > \config\codestyles folder.
> >
> > Sorry I can not volunteer to this as I'm bit uncertain about some coding
> > styles. But if some one lays down them here, I can help :).
> >
> > >
> > > * We decided on either 80 or 100 char lines back in December (seach
> the
> > > archives for "80 columns"), and yet there are a lot of lines > 120
> chars.
> > >
> > > * Lack of comments. It is really important to have at least some
> notion
> > > of what each class is for, and ideally a good explanation, in the
> > > JavaDoc header for that class (ditto for methods). Lots of our current
> > > classes/methods are missing any comments.
> >
> > Will do this. I also need some time to do it.
> >
> > Regards,
> > Chinthaka
> >
> > >
> > > Can folks try to rectify these things as we continue to work in
> various
> > > places?
> > >
> > > Thanks,
> > > --Glen
> > >
> > > P.S. I'm super-pleased at the speed and size so far!! Nice job!
> > >
> >
> >
> >
> >
>
>
>
"May the SourcE be with u"
http://www.bloglines.com/blog/thilina
RE: [axis2] Code commentary
Posted by Glen Daniels <gl...@thoughtcraft.com>.
> >btw, whats most popular IDE for Axis dev community? :-) I'm a big fan
> >of Eclipse.
> >
> You're not alone :-)
I have yet to re-try Eclipse after a bad experience with it several years ago. I know it's way better now and will eventually get
around to giving it a whirl again, but I've been totally digging IDEA for a long time now.
Let many flowers bloom and all that. :)
--Glen
Re: [axis2] Code commentary
Posted by Changshin Lee <ia...@gmail.com>.
Venkat Reddy wrote:
>For those who use Eclipse, it is as simple as right-clicking on the
>package or class and select "Source >> Format". The Eclipse bilt-in
>template will be applied. I think we can agree on the eclipse defalut
>template (also exported and attached here) for code, which also agrees
>with standard Java code conventions.
>
>btw, whats most popular IDE for Axis dev community? :-) I'm a big fan
>of Eclipse.
>
>
You're not alone :-)
Ias
>-venkat
>
>
>
>On 7/10/05, Eran Chinthaka <ch...@opensource.lk> wrote:
>
>
>>Hi Glen and all,
>>
>>
>>
>>>Hi folks!
>>>
>>>I'm re-ramping up on the current state of Axis2, and hoping to dive in
>>>for some substantive coding work in the next few days (some work on
>>>modules and looking into RPC/enc). As I'm going through the code, I
>>>notice a few things:
>>>
>>>* Formatting inconsistencies all over the place... can we run the whole
>>>codebase through IDEA's "reformat code" tool? (+1 from me!)
>>>
>>>
>>+1 from me too. If some one can setup his IDE and save the code template and
>>send to us, that will be easy to share the same code style. So for others we
>>can enforce that by asking to put that template in the {IDEA_HOME}
>>\config\codestyles folder.
>>
>>Sorry I can not volunteer to this as I'm bit uncertain about some coding
>>styles. But if some one lays down them here, I can help :).
>>
>>
>>
>>>* We decided on either 80 or 100 char lines back in December (seach the
>>>archives for "80 columns"), and yet there are a lot of lines > 120 chars.
>>>
>>>* Lack of comments. It is really important to have at least some notion
>>>of what each class is for, and ideally a good explanation, in the
>>>JavaDoc header for that class (ditto for methods). Lots of our current
>>>classes/methods are missing any comments.
>>>
>>>
>>Will do this. I also need some time to do it.
>>
>>Regards,
>>Chinthaka
>>
>>
>>
>>>Can folks try to rectify these things as we continue to work in various
>>>places?
>>>
>>>Thanks,
>>>--Glen
>>>
>>>P.S. I'm super-pleased at the speed and size so far!! Nice job!
>>>
>>>
>>>
>>
>>
>>
>>
>>------------------------------------------------------------------------
>>
>><?xml version="1.0" encoding="UTF-8"?>
>><profiles version="8">
>><profile name="Axis2CodeFormat" version="8">
>><setting id="org.eclipse.jdt.core.formatter.align_type_members_on_columns" value="false"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_qualified_allocation_expression" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_binary_expression" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_compact_if" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression" value="80"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_array_initializer" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_multiple_fields" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_selector_in_method_invocation" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_superclass_in_type_declaration" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_enum_declaration" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_type_declaration" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration" value="16"/>
>><setting id="org.eclipse.jdt.core.formatter.blank_lines_after_imports" value="1"/>
>><setting id="org.eclipse.jdt.core.formatter.blank_lines_after_package" value="1"/>
>><setting id="org.eclipse.jdt.core.formatter.blank_lines_before_field" value="1"/>
>><setting id="org.eclipse.jdt.core.formatter.blank_lines_before_first_class_body_declaration" value="0"/>
>><setting id="org.eclipse.jdt.core.formatter.blank_lines_before_imports" value="1"/>
>><setting id="org.eclipse.jdt.core.formatter.blank_lines_before_member_type" value="1"/>
>><setting id="org.eclipse.jdt.core.formatter.blank_lines_before_method" value="1"/>
>><setting id="org.eclipse.jdt.core.formatter.blank_lines_before_new_chunk" value="1"/>
>><setting id="org.eclipse.jdt.core.formatter.blank_lines_before_package" value="0"/>
>><setting id="org.eclipse.jdt.core.formatter.blank_lines_between_type_declarations" value="1"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_annotation_type_declaration" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_anonymous_type_declaration" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_array_initializer" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_block" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_block_in_case" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_constructor_declaration" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_enum_constant" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_enum_declaration" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_method_declaration" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_switch" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.brace_position_for_type_declaration" value="end_of_line"/>
>><setting id="org.eclipse.jdt.core.formatter.comment.clear_blank_lines" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.comment.format_comments" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.comment.format_header" value="false"/>
>><setting id="org.eclipse.jdt.core.formatter.comment.format_html" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.comment.format_source_code" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.comment.indent_parameter_description" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.comment.indent_root_tags" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.comment.line_length" value="80"/>
>><setting id="org.eclipse.jdt.core.formatter.compact_else_if" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.continuation_indentation" value="2"/>
>><setting id="org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer" value="2"/>
>><setting id="org.eclipse.jdt.core.formatter.format_guardian_clause_on_one_line" value="false"/>
>><setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_constant_header" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_declaration_header" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_type_header" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.indent_breaks_compare_to_cases" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_block" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_body" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_cases" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch" value="false"/>
>><setting id="org.eclipse.jdt.core.formatter.indentation.size" value="4"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_opening_brace_in_array_initializer" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_at_end_of_file_if_missing" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_catch_in_try_statement" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_closing_brace_in_array_initializer" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_else_in_if_statement" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_finally_in_try_statement" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_while_in_do_statement" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_anonymous_type_declaration" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_block" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_enum_constant" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_enum_declaration" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_method_body" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_type_declaration" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_and_in_type_parameter" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_assignment_operator" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation_type_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_binary_operator" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_arguments" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_parameters" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_brace_in_block" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_paren_in_cast" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_assert" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_case" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_conditional" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_for" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_labeled_statement" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_allocation_expression" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_annotation" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_array_initializer" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_parameters" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_throws" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_constant_arguments" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_declarations" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_explicitconstructorcall_arguments" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_increments" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_inits" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_parameters" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_throws" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_invocation_arguments" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_field_declarations" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_local_declarations" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_parameterized_type_reference" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_superinterfaces" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_arguments" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_parameters" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_ellipsis" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_parameterized_type_reference" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_arguments" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_parameters" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_brace_in_array_initializer" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_allocation_expression" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_reference" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_annotation" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_cast" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_catch" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_constructor_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_enum_constant" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_for" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_if" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_invocation" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_parenthesized_expression" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_switch" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_synchronized" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_while" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_postfix_operator" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_prefix_operator" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_conditional" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_wildcard" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_for" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_after_unary_operator" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_and_in_type_parameter" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_assignment_operator" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_at_in_annotation_type_declaration" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_binary_operator" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_parameterized_type_reference" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_arguments" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_parameters" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_brace_in_array_initializer" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_allocation_expression" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_reference" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_annotation" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_cast" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_catch" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_constructor_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_enum_constant" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_for" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_if" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_invocation" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_parenthesized_expression" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_switch" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_synchronized" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_while" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_assert" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_case" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_conditional" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_default" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_for" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_labeled_statement" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_allocation_expression" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_annotation" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_array_initializer" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_parameters" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_throws" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_constant_arguments" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_declarations" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_explicitconstructorcall_arguments" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_increments" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_inits" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_parameters" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_throws" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_invocation_arguments" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_field_declarations" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_local_declarations" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_parameterized_type_reference" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_superinterfaces" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_arguments" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_parameters" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_ellipsis" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_parameterized_type_reference" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_arguments" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_parameters" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_annotation_type_declaration" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_anonymous_type_declaration" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_array_initializer" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_block" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_constructor_declaration" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_constant" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_declaration" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_method_declaration" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_switch" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_type_declaration" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_allocation_expression" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_reference" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_type_reference" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation_type_member_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_catch" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_constructor_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_enum_constant" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_for" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_if" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_invocation" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_parenthesized_expression" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_switch" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_synchronized" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_while" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_postfix_operator" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_prefix_operator" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_conditional" value="insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_wildcard" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_for" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_before_unary_operator" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_between_brackets_in_array_type_reference" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_braces_in_array_initializer" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_brackets_in_array_allocation_expression" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_annotation_type_member_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_constructor_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_enum_constant" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_declaration" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_invocation" value="do not insert"/>
>><setting id="org.eclipse.jdt.core.formatter.keep_else_statement_on_same_line" value="false"/>
>><setting id="org.eclipse.jdt.core.formatter.keep_empty_array_initializer_on_one_line" value="false"/>
>><setting id="org.eclipse.jdt.core.formatter.keep_imple_if_on_one_line" value="false"/>
>><setting id="org.eclipse.jdt.core.formatter.keep_then_statement_on_same_line" value="false"/>
>><setting id="org.eclipse.jdt.core.formatter.lineSplit" value="80"/>
>><setting id="org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_method_body" value="0"/>
>><setting id="org.eclipse.jdt.core.formatter.number_of_empty_lines_to_preserve" value="1"/>
>><setting id="org.eclipse.jdt.core.formatter.put_empty_statement_on_new_line" value="true"/>
>><setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="tab"/>
>><setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="4"/>
>></profile>
>></profiles>
>>
>>
RE: [axis2] Code commentary
Posted by Eran Chinthaka <ch...@opensource.lk>.
Hi,
>
> For those who use Eclipse, it is as simple as right-clicking on the
> package or class and select "Source >> Format". The Eclipse bilt-in
> template will be applied. I think we can agree on the eclipse defalut
> template (also exported and attached here) for code, which also agrees
> with standard Java code conventions.
I didn't see line length as 100 in the attached template. I think it was 80.
>
> btw, whats most popular IDE for Axis dev community? :-) I'm a big fan
> of Eclipse.
Popularity does not make sense and has zero information. Individual
convenience is what that matters ;).
Hope we will not gonna start the Eclipse vs Idea war here :).
-- Chinthaka
>
> -venkat
>
>
>
> On 7/10/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> > Hi Glen and all,
> >
> > >
> > > Hi folks!
> > >
> > > I'm re-ramping up on the current state of Axis2, and hoping to dive in
> > > for some substantive coding work in the next few days (some work on
> > > modules and looking into RPC/enc). As I'm going through the code, I
> > > notice a few things:
> > >
> > > * Formatting inconsistencies all over the place... can we run the
> whole
> > > codebase through IDEA's "reformat code" tool? (+1 from me!)
> >
> > +1 from me too. If some one can setup his IDE and save the code template
> and
> > send to us, that will be easy to share the same code style. So for
> others we
> > can enforce that by asking to put that template in the {IDEA_HOME}
> > \config\codestyles folder.
> >
> > Sorry I can not volunteer to this as I'm bit uncertain about some coding
> > styles. But if some one lays down them here, I can help :).
> >
> > >
> > > * We decided on either 80 or 100 char lines back in December (seach
> the
> > > archives for "80 columns"), and yet there are a lot of lines > 120
> chars.
> > >
> > > * Lack of comments. It is really important to have at least some
> notion
> > > of what each class is for, and ideally a good explanation, in the
> > > JavaDoc header for that class (ditto for methods). Lots of our
> current
> > > classes/methods are missing any comments.
> >
> > Will do this. I also need some time to do it.
> >
> > Regards,
> > Chinthaka
> >
> > >
> > > Can folks try to rectify these things as we continue to work in
> various
> > > places?
> > >
> > > Thanks,
> > > --Glen
> > >
> > > P.S. I'm super-pleased at the speed and size so far!! Nice job!
> > >
> >
> >
> >
> >
Re: [axis2] Code commentary
Posted by Venkat Reddy <vr...@gmail.com>.
For those who use Eclipse, it is as simple as right-clicking on the
package or class and select "Source >> Format". The Eclipse bilt-in
template will be applied. I think we can agree on the eclipse defalut
template (also exported and attached here) for code, which also agrees
with standard Java code conventions.
btw, whats most popular IDE for Axis dev community? :-) I'm a big fan
of Eclipse.
-venkat
On 7/10/05, Eran Chinthaka <ch...@opensource.lk> wrote:
> Hi Glen and all,
>
> >
> > Hi folks!
> >
> > I'm re-ramping up on the current state of Axis2, and hoping to dive in
> > for some substantive coding work in the next few days (some work on
> > modules and looking into RPC/enc). As I'm going through the code, I
> > notice a few things:
> >
> > * Formatting inconsistencies all over the place... can we run the whole
> > codebase through IDEA's "reformat code" tool? (+1 from me!)
>
> +1 from me too. If some one can setup his IDE and save the code template and
> send to us, that will be easy to share the same code style. So for others we
> can enforce that by asking to put that template in the {IDEA_HOME}
> \config\codestyles folder.
>
> Sorry I can not volunteer to this as I'm bit uncertain about some coding
> styles. But if some one lays down them here, I can help :).
>
> >
> > * We decided on either 80 or 100 char lines back in December (seach the
> > archives for "80 columns"), and yet there are a lot of lines > 120 chars.
> >
> > * Lack of comments. It is really important to have at least some notion
> > of what each class is for, and ideally a good explanation, in the
> > JavaDoc header for that class (ditto for methods). Lots of our current
> > classes/methods are missing any comments.
>
> Will do this. I also need some time to do it.
>
> Regards,
> Chinthaka
>
> >
> > Can folks try to rectify these things as we continue to work in various
> > places?
> >
> > Thanks,
> > --Glen
> >
> > P.S. I'm super-pleased at the speed and size so far!! Nice job!
> >
>
>
>
>