[Webtest] [dev] what naming patterns to use?

[Dierk Koenig]

Checkstyle is now included in the build info. See
http://webtest.canoo.com/webtest/style/

The output could be a little bit more fancy...

I currently do not enforce the style, i.e. let the build
fail when the style check is broken. We may want to do this
after we have caught up.

The current style checks are based on the
Josh-Bloch-Effective-Java style with some few changes. See
http://webtest.canoo.com/viewrep/Canoo%20Webtest%20CVS/webtest/resources/che
ckstyle/config.xml?r=1.2

The current checks are fairly forgiving but it is a good
point to start and we can improve over time.

cheers
Mittie

> -----Original Message-----
> From: webtest-admin@lists.canoo.com
> [mailto:webtest-admin@lists.canoo.com]On Behalf Of Dierk Koenig
> Sent: Mittwoch, 3. November 2004 11:25
> To: webtest@lists.canoo.com
> Subject: RE: [Webtest] [dev] what naming patterns to use?
>
>
> ok. I'll go ahead with including checkstyle.
> Mittie
>
> > -----Original Message-----
> > From: webtest-admin@lists.canoo.com
> > [mailto:webtest-admin@lists.canoo.com]On Behalf Of Marc Guillemot
> > Sent: Dienstag, 2. November 2004 22:22
> > To: webtest@lists.canoo.com
> > Subject: Re: [Webtest] [dev] what naming patterns to use?
> >
> >
> > Hi,
> >
> > I agree that we have to define a common naming pattern. I
> > couldn't distinguish any in existing code therefore I've
> > contributed to the current state using sometimes mine, sometimes
> > what already was in the class I was working on.
> >
> > Ok for using checkstyle.
> >
> > My style is of course the best one ;-) but it will be an endless
> > discussion if we start looking at each developer's
> > prefered coding convention. Mittie, just decide and configure
> > checkstyle to ensure that the guidelines are respected.
> >
> > Marc.
> >
> > Dierk Koenig wrote:
> > > Hi developers,
> > >
> > > so far we have used the Taligent naming pattern, i.e.
> > > - local param names are "as is"
> > > - fields are prefixed with "f"
> > > - static fields (if any) are prefixed with "s"
> > >
> > > the recent changes deviate from that pattern by e.g.
> > > - fields are sometimes prefixed with "_" (JDK style)
> > > - local params are sometimes suffixed with "_"
> > >
> > > I don't want to be picky about these details as
> > > any decent IDE shows the distinctions anyway but
> > > there may be a specific reason for the style change
> > > that I haven't seen so far.
> > >
> > > - What style does everybody prefer?
> > >   (I can live with any style)
> > > - Does everybody agree on having a consistent style?
> > >   (we could use checkstyle in the build)
> > >
> > > cheers
> > > Mittie
> > >
> > > _______________________________________________
> > > WebTest mailing list
> > > WebTest@lists.canoo.com
> > > http://lists.canoo.com/mailman/listinfo/webtest
> > >
> >
> > _______________________________________________
> > WebTest mailing list
> > WebTest@lists.canoo.com
> > http://lists.canoo.com/mailman/listinfo/webtest
> >
> _______________________________________________
> WebTest mailing list
> WebTest@lists.canoo.com
> http://lists.canoo.com/mailman/listinfo/webtest
>