Mailing List Archive

coding conventions
Scott Ganyo wrote:
> Nevertheless, I'm willing to accept that you have defined it as "Lucene
> standard style" and I do abide by it when developing Lucene...

I don't think style should be (or even can be) mandated. When writing
new code from scratch, a developer should of course try use a style that
is not egregiously different than that of the code that it's destined to
join, but he or she doesn't have to rigidly adhere to an identical
style. When editing existing code, a good-faith effort should be made
to adhere to its existing style. That's just good manners.

In general, we should respect the styles of other developers, and hope
in turn that they will respect our style choices. I don't mind a
project with a variety of styles: the personality of the developer
should show in the code. I don't even mind a class with different
methods coded in different styles if they were written at different
times and/or by different developers.

So I don't think there is a "Lucene standard style". There's my style,
which accounts for a lot of the code because I wrote a lot of the code.
But, for example, the German analyzer, which I did not write, is in a
different style. That's not mayhem, it's just tolerance of diversity.

Doug


--
To unsubscribe, e-mail: <mailto:lucene-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:lucene-dev-help@jakarta.apache.org>
Re: coding conventions [ In reply to ]
Yeah, forcing is not nice, but even these expectations below is a mild
form of force, and worth documenting, in my opinion. Not everyone will
know what is expected of them.
Furthermore, consistent coding style, even if not one's favourite
style, makes code easier to read and understand, than code with a mix
of styles.
Anyhow, lets move on... :)

Otis

--- Doug Cutting <cutting@lucene.com> wrote:
> Scott Ganyo wrote:
> > Nevertheless, I'm willing to accept that you have defined it as
> "Lucene
> > standard style" and I do abide by it when developing Lucene...
>
> I don't think style should be (or even can be) mandated. When
> writing
> new code from scratch, a developer should of course try use a style
> that
> is not egregiously different than that of the code that it's destined
> to
> join, but he or she doesn't have to rigidly adhere to an identical
> style. When editing existing code, a good-faith effort should be
> made
> to adhere to its existing style. That's just good manners.
>
> In general, we should respect the styles of other developers, and
> hope
> in turn that they will respect our style choices. I don't mind a
> project with a variety of styles: the personality of the developer
> should show in the code. I don't even mind a class with different
> methods coded in different styles if they were written at different
> times and/or by different developers.
>
> So I don't think there is a "Lucene standard style". There's my
> style,
> which accounts for a lot of the code because I wrote a lot of the
> code.
> But, for example, the German analyzer, which I did not write, is in
> a
> different style. That's not mayhem, it's just tolerance of
> diversity.
>
> Doug
>
>
> --
> To unsubscribe, e-mail:
> <mailto:lucene-dev-unsubscribe@jakarta.apache.org>
> For additional commands, e-mail:
> <mailto:lucene-dev-help@jakarta.apache.org>
>


__________________________________________________
Do you Yahoo!?
New DSL Internet Access from SBC & Yahoo!
http://sbc.yahoo.com

--
To unsubscribe, e-mail: <mailto:lucene-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:lucene-dev-help@jakarta.apache.org>