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:[EMAIL PROTECTED] > 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:[EMAIL PROTECTED] > > 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 <[EMAIL PROTECTED]> 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 <[EMAIL PROTECTED]> 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> > >
