Mailing-List: contact axis-dev-help@ws.apache.org; run by ezmlm
Precedence: bulk
Reply-To: axis-dev@ws.apache.org
Received-SPF: pass (asf.osuosl.org: local policy)
Content-class: urn:content-classes:message
MIME-Version: 1.0
Content-Type: text/plain;
	charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
Subject: RE: [axis2] Code commentary
Date: Mon, 11 Jul 2005 14:18:07 -0400
Message-ID: <DF7DDC436B0D964A810AAA384B6A78ED0BE3E2@usmail3k3.us.Micros.int>
Thread-Topic: [axis2] Code commentary
Thread-Index: AcWGKpZmU7FJmfYLQXurlTmJnCU46wAF0bWgAAC8qgA=
From: "Kellogg, Richard" <RKellogg@MICROS.COM>
To: <axis-dev@ws.apache.org>

I would suggest they go under ws.apache.org instead.  Just a thought.

Rick


-----Original Message-----
From: Glen Daniels [mailto:glen@thoughtcraft.com]=20
Sent: Monday, July 11, 2005 2:04 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=20

> -----Original Message-----
> From: Thilina Gunarathne [mailto:csethil@gmail.com]=20
> Sent: Monday, July 11, 2005 3:03 AM
> To: axis-dev@ws.apache.org
> Subject: Re: [axis2] Code commentary
>=20
> Hi all,
> =20
> >>We decided on either 80 or 100 char lines back in December=20
> (seach the
> >>archives for "80 columns"),
> =20
> I got involved with Axis2 only after last December. I got to=20
> know this decision only from this thread. Also earlier this=20
> month I got to know that we have agreed to use American=20
> English for spellings.=20
> =20
> I feel it's better to have these decisions regarding to Code=20
> Styles that we use in Axis2 documented in somewhere, so that=20
> the new Commiters like me can take benefit of them. It'll be=20
> a good guide to new Commiters and also it'll help to improve=20
> the code quality of Axis2.=20
> =20
> Thanks & Regards,
> ~Thilina
> =20
> =20
> On 7/11/05, Venkat Reddy <vreddyp@gmail.com> wrote:
>=20
> 	For those who use Eclipse, it is as simple as=20
> right-clicking on the
> 	package or class and select "Source >> Format". The=20
> Eclipse bilt-in=20
> 	template will be applied. I think we can agree on the=20
> eclipse defalut
> 	template (also exported and attached here) for code,=20
> which also agrees
> 	with standard Java code conventions.
> =09
> 	btw, whats most popular IDE for Axis dev community? :-)=20
> I'm a big fan=20
> 	of Eclipse.
> =09
> 	-venkat
> =09
> =09
> =09
> 	On 7/10/05, Eran Chinthaka <chinthaka@opensource.lk> wrote:
> 	> Hi Glen and all,
> 	>
> 	> >
> 	> > Hi folks!=20
> 	> >
> 	> > I'm re-ramping up on the current state of Axis2,=20
> and hoping to dive in
> 	> > for some substantive coding work in the next few=20
> days (some work on
> 	> > modules and looking into RPC/enc).  As I'm going=20
> through the code, I=20
> 	> > notice a few things:
> 	> >
> 	> > * Formatting inconsistencies all over the place...=20
> can we run the whole
> 	> > codebase through IDEA's "reformat code" tool?  (+1 from me!)
> 	>=20
> 	> +1 from me too. If some one can setup his IDE and=20
> save the code template and
> 	> send to us, that will be easy to share the same code=20
> style. So for others we
> 	> can enforce that by asking to put that template in=20
> the {IDEA_HOME}=20
> 	> \config\codestyles folder.
> 	>
> 	> Sorry I can not volunteer to this as I'm bit=20
> 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=20
> December (seach the=20
> 	> > archives for "80 columns"), and yet there are a lot=20
> of lines > 120 chars.
> 	> >
> 	> > * Lack of comments.  It is really important to have=20
> at least some notion
> 	> > of what each class is for, and ideally a good=20
> explanation, in the=20
> 	> > JavaDoc header for that class (ditto for methods). =20
> Lots of our current
> 	> > classes/methods are missing any comments.
> 	>
> 	> Will do this. I also need some time to do it.
> 	>
> 	> Regards,=20
> 	> Chinthaka
> 	>
> 	> >
> 	> > Can folks try to rectify these things as we=20
> continue to work in various
> 	> > places?
> 	> >
> 	> > Thanks,
> 	> > --Glen
> 	> >
> 	> > P.S.  I'm super-pleased at the speed and size so=20
> far!!  Nice job!
> 	> >
> 	>
> 	>
> 	>
> 	>
> =09
> =09
> =09
>=20
>=20
> "May the SourcE be with u"=20
> http://www.bloglines.com/blog/thilina=20
> <http://www.bloglines.com/blog/thilina> =20
>=20