top | item 4200270

(no title)

mkmcdonald | 13 years ago

> I find that naming things descriptively and an 80 character limit are at odds.

I don't. I use descriptive names for functions and short, concise words for variables (sometimes clear abbreviations).

> Another nit, Google Style guides disallow formatting for readability except for comments?!?!

> Allowed

> [regularly formatted variable declarations]

> Not allowed

> ["pretty" formatted variable declarations with indentation]

Code Complete 2 explicitly discourages the latter style, and I tend to agree. It's too difficult to maintain.

discuss

order

greggman|13 years ago

>> I find that naming things descriptively and an 80 character limit are at odds. > I don't. I use descriptive names for functions and short, concise words for variables (sometimes clear abbreviations)

That might work. Unfortunately abbreviations are forbidden by the Google Style Guide.

> As for lining up

my point still holds. Either lining up helps or it doesn't. If it doesn't help then lining up comments should not be allowed. If it does help, then it helps every where.

    var infos = [
      { name: "red",   value: [255,   0,   0, 255], },
      { name: "green", value: [  0, 255,   0, 255], },
      { name: "blue",  value: [  0,   0, 255, 255], }
    ];
Is vastly easier to read and find errors in IMO than this

    var infos = [
      { name: "red", value: [255, 0, 0, 255], },
      { name: "green", value: [ 0, 255, 0, 255], },
      { name: "blue", value: [ 0, 0, 255, 255], }
    ];
The first is not allowed by the Google Style guide. It requires the 2nd.

mundizzle|13 years ago

i generally avoid putting all properties of an object in one the same line in the name of readability and also to avoid the 80 char limit.

instead i do something like this. (incorrect trailing commas removed from the previous example)

  var infos = [
    {
      name: "red",
      value: [255, 0, 0, 255]
    },
    {
      name: "green",
      value: [0, 255, 0, 255]
    },
    {
      name: "blue",
      value: [0, 0, 255, 255]
    }
  ];

mhansen|13 years ago

Nowhere are abbreviations forbidden by the Google Style Guide.

binarysoul|13 years ago

its not difficult to maintain. Emacs in particular has M-x align-regexp = (which does the alignment for you)