[Algemeen] Coding conventies

[BtM909]

Ik kwam een JS voorbeeld tegen op Ajaxian.com (welke ik heel toevallig ook toepas) om code iets anders te stylen (om basis fouten sneller op te pakken)

JavaScript:

// See comments below.

// standard style
var a = "ape",
  b = "bat",
  c = "cat",
  d = "dog",
  e = "elf",
  f = "fly",
  g = "gnu",
  h = "hat",
  i = "ibu";

// comma-first style
var a = "ape"
  , b = "bat"
  , c = "cat"
  , d = "dog"
  , e = "elf"
  , f = "fly"
  , g = "gnu"
  , h = "hat"
  , i = "ibu"
  ;

// error in standard style
var a = "ape",
  b = "bat",
  c = "cat",
  d = "dog"
  e = "elf",
  f = "fly",
  g = "gnu",
  h = "hat",
  i = "ibu";

// error in comma-first style
var a = "ape"
  , b = "bat"
  , c = "cat"
  , d = "dog"
  e = "elf"
  , f = "fly"
  , g = "gnu"
  , h = "hat"
  , i = "ibu"
  ;

// Objects:

// JSON.stringify style
var o = {
    a : "ape",
    b : "bat",
    c : "cat",
    d : "dog",
    e : "elf",
    f : "fly",
    g : "gnu",
    h : "hat",
    i : "ibu"
  },
  a = [
    [ "ape", "bat" ],
    [ "cat", "dog" ],
    [ "elf", "fly" ],
    [ "gnu", "hat" ],
    [ "ibu" ]
  ];
  

// comma-first
var o =
    { a : "ape"
    , b : "bat"
    , c : "cat"
    , d : "dog"
    , e : "elf"
    , f : "fly"
    , g : "gnu"
    , h : "hat"
    , i : "ibu"
    }
  , a =
    [ [ "ape", "bat" ]
    , [ "cat", "dog" ]
    , [ "elf", "fly" ]
    , [ "gnu", "hat" ]
    , [ "ibu" ]
    ];

// errors in objects:

// JSON.stringify style
var o = {
    a : "ape",
    b : "bat",
    c : "cat",
    d : "dog"
    e : "elf",
    f : "fly",
    g : "gnu",
    h : "hat",
    i : "ibu"
  },
  a = [
    [ "ape", "bat" ],
    [ "cat", "dog" ],
    [ "elf", "fly" ]
    [ "gnu", "hat" ],
    [ "ibu" ]
  ];
  

// comma-first
var o =
    { a : "ape"
    , b : "bat"
    , c : "cat"
    , d : "dog"
    e : "elf"
    , f : "fly"
    , g : "gnu"
    , h : "hat"
    , i : "ibu"
    }
  , a =
    [ [ "ape", "bat" ]
    , [ "cat", "dog" ]
    , [ "elf", "fly" ]
    [ "gnu", "hat" ]
    , [ "ibu" ]
    ];

Het gaat in dit geval om de comma-first notation (voor 't geval dat nog niet duidelijk was )

Zien jullie baat bij om je source code zo op te tuigen of gebruik je helemaal geen code conventie voor je sources?

Ben wel nieuwsgierig hoe jullie met (clientside)codering omgaan

[Gamebuster]

JavaScript:

var a = 0;
var b = 1;
var c = [1,2,3,[4,5]];
var d = {
    "a":"b",
    "c":"d",
    "e":{
        "f":"g",
        "h":"i"
    }
};

Array's gooi ik meestal gewoon op 1 regel. Lange Array's breek ik gewoon af na X aantal tekens.
Object's schrijf ik over meerdere regels. Soms uitzonderingen wanneer het een klein object is met slechts 1 of 2 key/value paren of wanneer het object inline wordt gedefineerd als argument voor een functie.

edit:
Comma last dus

offtopic:
bericht niet helemaal gelezen

[ Voor 55% gewijzigd door Gamebuster op 08-04-2010 15:09 ]

[HenkEisDS]

Gamebuster schreef op donderdag 08 april 2010 @ 14:58:

JavaScript:

var a = 0;
var b = 1;
var c = [2,3,4,5];
var d = 
{
    "a":"b",
    "c":"d",
    "e":
     {
        "f":"g",
        "h":"i"
     }
};

Ik zet mijn haakjes altijd op de volgende regel. Hierdoor krijg je wel meer witruimte, maar dat vind ik juist fijn. Ook kan ik zo makkelijker zien of ik alle haakjes netjes heb afgesloten.

[disjfa]

Ik gebruik zelf bijna altijd comma first. Dat scheelt zoveel lezen. Dan blijft alles op een verticale regel staan, en als je er dan een mist zie je dat binnen 0.1 seconden ipv dat je een paar minuten zit na te lezen welke komma je nu eigenlijk mist.

[ Voor 29% gewijzigd door disjfa op 08-04-2010 15:03 ]

[Gamebuster]

disjfa schreef op donderdag 08 april 2010 @ 15:02:
[...]

Dat heeft nog weinig met comma first te maken natuurlijk. Ik gebruik zelf bijna altijd comma first. Dat scheelt zoveel lezen. Dan blijft alles op een verticale regel staan, en als je er dan een mist zie je dat binnen 0.1 seconden ipv dat je een paar minuten zit na te lezen welke komma je nu eigenlijk mist.

comma last Dus. Rede: ";" staat ook op het einde van de regel. ",", "+" en een line-break zet ik dan ook altijd op de laatste regel:

JavaScript:

var e = "regel 1\n\
regel 2";
var f = "regel 1\n"+
    "regel 2";

Ik kan me niet verplaatsen in het probleem over vergeten komma; mijn editor kan prima weergeven waar ik een komma vergeten ben, evenals het vergeten haakje.

[ Voor 27% gewijzigd door Gamebuster op 08-04-2010 15:12 ]

[Aganim]

Komma's op de laatste plaats. Ik vind het niet lekker lezen anders.

Verder ben ik niet zo strikt wat betreft conventies. Uiteraard duidelijke namen aan variabelen, maar zaken als strNaampje, intNaamje om aan te geven wat het voor type variabele is doe ik al lang niet meer.

Het gaat mij vooral om leesbaarheid, zolang de code leesbaar en te begrijpen is vind ik het al snel prima.
Dus uiteraard wel correct indenten, commentaar erbij etc. Maar als hobbyist kan je wat makkelijker zijn wat dat betreft.

[Sebazzz]

Aganim schreef op donderdag 08 april 2010 @ 17:57:
Komma's op de laatste plaats. Ik vind het niet lekker lezen anders.

Vind ik ook. Bovendien geeft Visual Studio anders wel een waarschuwing als de javascript niet correct is.

Qua conventies probeer ik zo veel mogelijk de conventies van de taal zelf aan te houden.