Probably an inane question, but why do we use the current JS coding patterns?

[RMWChaos]

Not to go against the grain or anything (or disagree with Douglas Crawford), but why is this considered the de-facto JS coding pattern:

// The "Crawford" pattern
function myFunc() {
    var a = "Hello";
    var b = "world";
    for (var i = 0; i < 3; i++) {
        alert(a + " " + b);
    };
};
 

When (to me) this is much clearer to read:

// The RMWChaos pattern ;-)
function myFunc()
    {
    var a = "Hello";
    var b = "world";
    for (var i = 0; i < 3; i++)
        {
        alert(a + " " + b);
        };
    };
 

In both cases, the code will be the same length when minimized, and they are syntacticly identical to one another. However, the second version just seems infinitely easier to read (to see where blocks begin, identify conditionals, etc.) and, therefore, easier to modify, bug-check, etc. (IMHO).

Am I alone here? Maybe this is just my bias from working with BASIC and COBOL for so long, and after a while I will see the first version as easier to read ... perhaps.

Oh, and what's the big deal about using spaces to indent (4, 8, 16, etc.) vs. Tab? So what if Tab lengths are not standardized between programs...as long as they are indented?

[acoder]

See this thread in the Software Development forum. It's more generic.

btw, I prefer the first method and I don't see why the second one has to be easier to read. In fact, the last bracket looks like it closes the for loop, but that's probably because I'm so used to the first method.

[RMWChaos]

See this thread in the Software Development forum. It's more generic.

btw, I prefer the first method and I don't see why the second one has to be easier to read. In fact, the last bracket looks like it closes the for loop, but that's probably because I'm so used to the first method.

I stated coding with Notepad and now with Notepad+. N+ highlights the code blocks with red lines when they are directly inline with one another, but only highlights the brackets themselves when they are indented differently.

// With Notepad+, brackets inline
 
    {           // All these lines are
    |   (...)   // highlighted when
    }           // brackets are inline.
 
// With Notepad+, brackets not inline
 
    {           // only this line...
    (...)
};              // and this line are highlighted
 

But even with just plain text, I still think it's easier to read. Just preference, I guess. I will read the link you provided, and may change my mind over time.

Thanks!

[RMWChaos]

I actually use the first method. I've never had bracket problems because I use indenting too and all brackets line up with the command.

I don't know how I started using this method as opposed to the second method, but it's stuck and I actually find the second method unsightly. If I'm copying code from somewhere or altering code, I'll change it to the first style (if it's not a lot of code). To save even more space, I'll also get rid of brackets altogether if it's a single line of code in if, for, while, etc.

Just personal habits.

Well, at least you're consistent. =D Funny, when I get code that looks the way you write it, with opening bracket on the same line, closing bracket inline with the function statement, I change it to look the way I prefer.

But unsightly!? C'mon, even a blind man can see my way looks waaaay prettier. =D

It seems that I am not, after all, alone on this point.

[Logician]

Not to go against the grain or anything (or disagree with Douglas Crawford), but why is this considered the de-facto JS coding pattern:

// The "Crawford" pattern
function myFunc() {
    var a = "Hello";
    var b = "world";
    for (var i = 0; i < 3; i++) {
        alert(a + " " + b);
    };
};
 

When (to me) this is much clearer to read:

// The RMWChaos pattern ;-)
function myFunc()
    {
    var a = "Hello";
    var b = "world";
    for (var i = 0; i < 3; i++)
        {
        alert(a + " " + b);
        };
    };
 

In both cases, the code will be the same length when minimized, and they are syntacticly identical to one another. However, the second version just seems infinitely easier to read

The first layout is often known to C programmers as K&R notation (Kernighan and Ritchie) Its sole purpose/advantage is to conserve space in published listings; it does nothing to help readability or debugging and makes checks for correct brace pairing a nightmare. Unfortunately it gets copied globally by beginners who don't know any better. A more useful way to save space is not to put single statements within braces. I would like to show the way I would write it, but this forum's broken software makes a complete mess of my indentation.

Oh, and what's the big deal about using spaces to indent (4, 8, 16, etc.) vs. Tab? So what if Tab lengths are not standardized between programs...as long as they are indented?

Tab characters used to indent listings are just unnecessary and annoying. Any decent editor can configure the tab key to insert a fixed number of spaces.

[RMWChaos]

I would like to show the way I would write it, but this forum's broken software makes a complete mess of my indentation.

Feel free to email me an example, if you don't mind! Like you, I don't like K&R for the same reasons you supplied.

Currently, I am partial to either of the two methods below, but would be interested to see yours as well.

function myFunc()
    {
    var a = "Hello";
    var b = "world";
    for (var i = 0; i < 3; i++)
        {
        alert(a + " " + b);
        };
    };
 
// ...or... //
 
function myFunc()
{
    var a = "Hello";
    var b = "world";
    for (var i = 0; i < 3; i++)
    {
        alert(a + " " + b);
    };
};
 

The only difference being the lack of additional indentation on the main function and for loop code blocks in the 2nd example. I can see where the 2nd example would be easier to read by those used to seeing the close bracket inline with the initiating statement. Otherwise, I like the first way, which is the way I have done it since starting to code JS.

At this point, I figure if other people don't like my method, they don't have to use it, and if they want to borrow from my code, they can modify it the way they prefer it. I will do the same. =D

Minify is going to take care of all these extra line breaks, indents, spaces, and dev notation anyway. The rest is just personal readability I suppose.

Thanks!

[Logician]

Feel free to email me an example, if you don't mind! Like you, I don't like K&R for the same reasons you supplied.

Sadly only an image is reliable here.

[RMWChaos]

So you align your brackets with the initial statement, but you are not using brackets with the for loop? Interesting. Is that reliable?

function myFunc()
{
  var a = "Hello", b = "world";
 
  for (var i = 0; i < 3; i++)
    alert(a + " " + b);
};
 

Is that about right? What if there is additional code after the alert? I don't see how that would not confuse the end of the for loop.

[gits]

if you leave the brackets then only one following statement is executed in that loop ...

i would never do that for my own ... i always use brackets even in the if-statements ... but its allowed and a lot of people do it that way

kind regards

[acoder]

Well, at least you're consistent. =D Funny, when I get code that looks the way you write it, with opening bracket on the same line, closing bracket inline with the function statement, I change it to look the way I prefer.

But unsightly!? C'mon, even a blind man can see my way looks waaaay prettier. =D

Hey, you weren't supposed to quote that! :D When did I write that?

I accept the points about brackets being easier to pair, but I don't have that problem because I'm consistent.

If I had to choose between yours and the 'other' method with one less indent, I'd choose that one any day.

But, hey, can't get too worked up about it. I can read all of these. The worst are something like this:

function something()
{
if (blah)
{
for (...)
{
...
}
}
}

Argh! No indentation - makes it a nightmare!

[gits]

The first layout is often known to C programmers as K&R notation (Kernighan and Ritchie) Its sole purpose/advantage is to conserve space in published listings; it does nothing to help readability or debugging and makes checks for correct brace pairing a nightmare. Unfortunately it gets copied globally by beginners who don't know any better.

i strongly disagree with that and in case you call douglas crockford a beginner who didn't know any better then i think you should tell us what javascript-guru you are :) i think i should bow to you ... ;)

kind regards

[RMWChaos]

i strongly disagree with that and in case you call douglas crockford a beginner who didn't know any better then i think you should tell us what javascript-guru you are :) i think i should bow to you ... ;)

kind regards

LOL! There are so many levels of amateur, professional, and guru between me and Douglas...I just bow to everyone to be safe. =D

If I had to choose between yours and the 'other' method with one less indent, I'd choose that one any day.

Now you're just being contrary. ;-)

Hey, you weren't supposed to quote that! :D When did I write that?

Um...

See this thread in the Software Development forum. It's more generic.

Maybe this is why you're stuck using the same ugly old style...short memory. =D

[Logician]

i strongly disagree with that and in case you call douglas crockford a beginner who didn't know any better then i think you should tell us what javascript-guru you are :) i think i should bow to you ... ;)

kind regards

Anyone in the business of publishing listings, finds themselves under the same pressure to save space, which is why they'll use the 'opening brace at end of line' format regardless of their opinion of it.

[acoder]

Now you're just being contrary. ;-)
Um...
Maybe this is why you're stuck using the same ugly old style...short memory. =D

I was only joking about you quoting me from another thread.

I'm not being contrary about choosing a particular method. I meant if I was forced to choose between your method and the method I find 'unsightly', I'd choose that one because yours seems a bit confusing being so used to using the command to line up with the closing bracket.

[acoder]

Anyone in the business of publishing listings, finds themselves under the same pressure to save space, which is why they'll use the 'opening brace at end of line' format regardless of their opinion of it.

I'm not so sure of that. He wouldn't then include it as a coding convention, would he?

[RMWChaos]

I was only joking about you quoting me from another thread.

I'm not being contrary about choosing a particular method. I meant if I was forced to choose between your method and the method I find 'unsightly', I'd choose that one because yours seems a bit confusing being so used to using the command to line up with the closing bracket.

Yeah, I know, it's just fun to pick on you. ;-)

[pbmods]

Here's what I don't like about omitting braces for single-line blocks:

var element = document.getElementById('theElement');
for( var i = 0; i < 10; ++i )
    doSomething();
element.doSomethingElse();
andSomeMoreStuff('table');
 

It's borderline-legible if indented properly; it would be a nightmare otherwise:

var element = document.getElementById('theElement');
for( var i = 0; i < 10; ++i )
doSomething();
element.doSomethingElse();
andSomeMoreStuff('table');
 

Or occasionally I see this (*shudder*):

var element = document.getElementById('theElement');
for( var i = 0; i < 10; ++i )
    doSomething();
    element.doSomethingElse();
    andSomeMoreStuff('table');
 

And just to throw my hat in the stack, I absolutely *hate* it when programmers put the opening brace on the same line as the declaration.

[helimeef]

I prefer the first method, dunno why. Just used to it.

[RMWChaos]

There is only one situation I have come across where the opening brace absolutely had to be on the same line as the opening statement...

var EventCache = function()
    {
    var listEvents = [];
    return {    // This brace must be on the same line or it errors
        listEvents : listEvents,
        ( ... )
 

I don't know why this is the case. All I do know is that if I move the brace one line lower, she throws an error.

[acoder]

Here's what I don't like about omitting braces for single-line blocks:...

There's no excuse for non-indentation whatever the style.

And just to throw my hat in the stack, I absolutely *hate* it when programmers put the opening brace on the same line as the declaration.

Why do those who like the brace-on-new-line style always seem to hate the brace-on-same-line style? Just wondering...

[gits]

Why do those who like the brace-on-new-line style always seem to hate the brace-on-same-line style? Just wondering...

:) i'm wondering too ...

[pbmods]

Why do those who like the brace-on-new-line style always seem to hate the brace-on-same-line style? Just wondering...

For me, it's because I'm used to following the curvy thing. It's just easier for me to line up matching braces rather than have to match it against indented text.

It also helps spread the code out a bit and makes it look a lot cleaner to me.

Of course, I usually take it a step further and mess with parentheses, too. You'll often see a lot of this in my code:

$__stmt =
    $db->prepareStatement
    (
        "EXEC [Some].[Stored].[Procedure] ?, ?, ?",
        array
        (
            (int) $customerID,
            (int) $offerID,
            $somethingElseIDunno
        )
    );
 

[acoder]

For me, it's because I'm used to following the curvy thing. It's just easier for me to line up matching braces rather than have to match it against indented text.

It also helps spread the code out a bit and makes it look a lot cleaner to me.

Oh, I know the reasons, understand them and accept them to an extent, but it still doesn't explain the absolute hatred for the on-same-line method as opposed to a simple dislike or just a preference of one over the other.

[RMWChaos]

Oh, I know the reasons, understand them and accept them to an extent, but it still doesn't explain the absolute hatred for the on-same-line method as opposed to a simple dislike or just a preference of one over the other.

Oh, I don't hate it (I try never to hate anything; causes too much grief in this world). In fact, I am considering moving to it, but as a relatively new coder, I like to have my braces and brackets line up so that I do not forget to close them. It makes for easy bug fixing IMHO. Helps when you forget to open one too, or am I the only person that ever does that? =D

[acoder]

Oh, I don't hate it (I try never to hate anything; causes too much grief in this world). In fact, I am considering moving to it, but as a relatively new coder, I like to have my braces and brackets line up so that I do not forget to close them. It makes for easy bug fixing IMHO. Helps when you forget to open one too, or am I the only person that ever does that? =D

That's OK then. At least we've got one. I'm not claiming the brackets/braces-on-the-same-line method is superior. I just feel that its supposed disadvantages seem a bit exaggerated.

[Logician]

There's no excuse for non-indentation whatever the style.

Why do those who like the brace-on-new-line style always seem to hate the brace-on-same-line style? Just wondering...

Simply because it requires more (unnecessary) effort to scrutinise the code for missing braces, when their presence should be made clear.

[Logician]

I'm not so sure of that. He wouldn't then include it as a coding convention, would he?

The fact that he's reiterating a convention doesn't mean that he agrees with it, just that he has to be seen to be consistent.

[acoder]

Simply because it requires more (unnecessary) effort to scrutinise the code for missing braces, when their presence should be made clear.

Each to their own, I guess. I don't find it difficult as long as the code is properly indented. However, I'm not going to argue about which one is better. I might even admit that having braces on a new line is probably better from a logical point of view. If we started all over again, we probably would've had that as the de facto standard, so to speak.

[pbmods]

However, I'm not going to argue about which one is better.

I will.

0>:} (<-- Horns holding up cheap tinfoil halo.)

[gits]

remember this is not a religious forum :)) ... no, just kidding ... but to me it seems that there are two groups of developers ... the ones that includes the brackets in their (even personal) 'code-view' and the others that don't ... i have no special preference for one of them ... but we use the 'crockford'-way (bracket-on-the-same-line) at work and so i use to always use it ... like acoder said ... i find the pointed problems with that exaggerated ... the much more important point is about the indentation ... and one more point to mention :) ... long lines ... i really hate that, just to say that i hate something too ... i hate long lines > 80 chars :)

kind regards