deltaspike-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From George Gastaldi <gegasta...@gmail.com>
Subject Re: basic decisions - coding conventions
Date Mon, 12 Dec 2011 12:53:48 GMT
+1 to Jakob additional suggestions.

2011/12/12 Jakob Korherr <jakob.korherr@gmail.com>

> Hi,
>
> I personally really like the rules we have at MyFaces, these are
>
> 1) No tabs, only spaces.
> 2) Bracelets on new line (IMO makes the code more readable)
> 3) Force bracelets
> 4) 4 spaces ident size (2 is too little and 3 is awkward - I've never
> seen 3..). Also, clear indentings make the code more readable.
> 5) a space between keyword and round bracket (e.g. if (...) instead of
> if(...))
> 6) a space before and after an operand (e.g. a = 1 + 2 or a != b
> instead of a=1+2 or a!=b)
>
> 5 and 6 are not soo important, but IMO very nice to have.
>
> Regards,
> Jakob
>
> 2011/12/12 Shane Bryzak <sbryzak@gmail.com>:
> > On Mon, Dec 12, 2011 at 9:37 PM, Mark Struberg <struberg@yahoo.de>
> wrote:
> >
> >> Hi!
> >>
> >> I'm a fan of a pretty tight coding convention observation even at build
> >> time.
> >>
> >> What we usually have (in owb and myfaces) is an own 'buildtools' project
> >> which contains the checkstyle rules as own artifact.
> >> This will then be used in the deltaspike-parent pom as dependency of the
> >> maven-checkstyle-plugin. I'll set this up, no worries, easy stuff.
> >>
> >> The more important thing is to decide _which_ coding conventions we like
> >> to follow at all?
> >>
> >> I have the following suggestions:
> >>
> >> 1.) no tabs, only spaces!
> >>
> >
> > +1, tabs suck
> >
> >
> >
> >>
> >> 2.) bracelets on new line? Actually I don't care about
> >> > if()
> >> > {
> >> >   dings();
> >> > }
> >> or
> >>
> >> > if() {
> >> >   dings();
> >> > }
> >> but we should only use one stile throughout the whole code.
> >>
> >>
> >
> > I don't mind either way here, comfortable with either as long as we pick
> > one and are consistent with it.
> >
> >
> >
> >>
> >> 3.) force bracelets
> >>
> >>  no
> >>
> >> > if()
> >>
> >> >   dosomething;
> >>
> >> without bracelets. Instead force:
> >> > if()
> >> > {
> >>
> >> >   dosomething;
> >> > }
> >>
> >>
> > +1
> >
> >
> >>
> >> I'm sure there is a bit more, thus please add the rules which are
> >> important for you.
> >> (PS: once we found a final solution we should move this into our wiki +
> >> provide Eclipse and Idea checkstyle rules.
> >>
> >
> >
> > One thing to decide is indent size.  Currently in Seam we use 4 spaces,
> as
> > we've recently adopted the JBoss coding standards.  Personally, I think
> > this is a little too much, previously we had 3 spaces (Gavin's
> preference)
> > which I thought was better.
> >
> >
> >
> >>
> >>
> >> LieGrue,
> >> strub
> >>
> >>
>
>
>
> --
> Jakob Korherr
>
> blog: http://www.jakobk.com
> twitter: http://twitter.com/jakobkorherr
> work: http://www.irian.at
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message