JavaScript elnevezési szokások: tennivalók és nem tennivalók

Elképesztőnek tartom, hogy mennyi különböző jelentést kaphatunk kevesebb, mint 30 karakterből. Az ábécéről beszélek, természetesen jól elhelyezett írásjelekkel. A szerelmi történettől a számítógépes programig az írás lehetővé tette számunkra, hogy rendkívül különböző világokat alkossunk. A nyelv pedig általában olyan keretet nyújt, amelybe ötleteket sodorhatunk.

Úgy tűnik, hogy a legtöbb programozási nyelv nagyon szigorú előírásokkal rendelkezik - bizonyos helyeken bizonyos kifejezéseket kell használni. De az egyik terület, ahol óriási szabadság van, nevezzük ezeket a kifejezéseket.

Vegyük ezt az egyszerű programot, amely egy mondatból állít elő egy tömböt, felvesz egy írásjelet és naplózza a konzolba:

Semmi különös, igaz? De amit esetleg nem vett figyelembe, az az, hogy hány kifejezést volt felelős megnevezni.

A fenti programban 23 szó van (a kódolt értékeket nem tartalmazva). E szavak közül 14 nevét kontrolláltuk. Ez a gépeltek több mint 60% -a, felelősségünk volt megnevezni!

Akár vállalati alkalmazást épít, akár egy egyszerű Hello, World-t, azt szeretné , hogy a program úgy olvasson, mint egy Times Bestseller, nem pedig a Mad Libs munkafüzet.

Ez nem egy manifeszt egy teljes JavaScript alkalmazás felépítéséről, hanem egy fejezet arról, hogyan válasszunk neveket azokra a dolgokra, amelyekben szabadon megteheti. Ha többet szeretne megtudni, alulra felvettem a különféle hivatkozásokat. Egy utolsó dolog, minden egyezményünk és normánk legfontosabb elvétele ez:

Ezeknek a konvencióknak a nagy része ma nem neked szól, hanem helyetted és a holnap a kódodat olvasó emberek számára.

Referenciák és továbbtanulás

  1. Robert C. Martin „Tiszta kódja” - nagyszerű olvasmány minden nyelv számára. Túllépi a konvenciók elnevezését és javasolja a program teljes felépítését. A példák Java-ban vannak, de az alapelvek a JavaScript-re is érvényesek.
  2. Ryan Mcdermott „Clean Code JavaScript” - A fenti könyv, de átdolgoztuk a JavaScript számára. Online elérhető és ingyenes.
  3. Airbnb JavaScript stílus útmutató - Esetleg a legátfogóbb stílus útmutató a JavaScript számára. Nemcsak a mit, hanem a miérteket is tartalmazza. (Ha kicsi eszközt használ, akkor a teljes dokumentum megtekintéséhez kattintson az „összes olvasási fájl megtekintése” lehetőségre).
  4. W3 JavaScript stílus útmutató - Egy rövid és tömör útmutató.
  5. A Google ES6 stílusútmutatója - a Google stílus útmutatója a JavaScript használatához.

Köszönöm, hogy elolvasta!

woz

Kövess a Twitteren.