2. שמות של משתנים
שמות של משתנים, מחלקות ושיטות:
functionNamesLikeThis
שמות של ערכים קבועים:
CONSTANT_VALUES_LIKE_THIS
3. סוגריים מסולסלים
יתחילו באותה השורה של מה שהם פותחים ●
יסתיימו בשורה נפרדת ●
רווח לפני ●
{ )if (something
... //
{ } else
... //
}
4. אתחול מערכים ואובייקטים
הכנסת נתונים לתוך מערך נעשית ברצף בשורה אחת כאשר האורך לא עולה על
:שורה
var arr = [1, 2, 3];
:הכנסת נתונים לתוך מערך בשורות נפרדות כאשר האורך עולה על שורה
var arr = [
'"Slartibartfast" <fjordmaster@magrathea.com>',
'"Zaphod Beeblebrox" <theprez@universe.gov>',
'"Ford Prefect" <ford@theguide.com>',
'"Arthur Dent" <has.no.tea@gmail.com>',
'"Marvin the Paranoid Android" <marv@googlemail.com>',
'the.mice@magrathea.com'
];
5. אתחול מערכים ואובייקטים
:תמיד העדיפו לא ליישר את הטקסט של הרשימות
CORRECT_Object.prototype = {
a: 0,
b: 1,
lengthyName: 2
};
WRONG_Object.prototype = {
a : 0,
b : 1,
lengthyName: 2
};
6. פונקציות
.כשאפשר, רצוי שכל רשימת המשתנים שפונקציה מקבלת תופיע בשורה אחת
:אם זה לא מתאפשר, צריך לכתוב את הרשימה כך שתהיה קריאה וברורה
function foo(veryDescriptiveArgumentNumberOne, veryDescriptiveArgumentTwo,
tableModelEventHandlerProxy, artichokeDescriptorAdapterIterator)
{
// ...
}
function bar(veryDescriptiveArgumentNumberOne,
veryDescriptiveArgumentTwo,
tableModelEventHandlerProxy,
artichokeDescriptorAdapterIterator) {
// ...
}
7. הזחה
כשקוד לא נכנס בשורה אחת אלא בכמה שורות, יש ליישר את הטקסט בשורות
הבאות לטקסט בשורה הראשונה, או להשתמש בהזחה של 4 רווחים.
הכל נכנס בשורה אחת:
;var x = a ? b : c
הזחה של 4 רווחים:
? var y = a
;longButSimpleOperandB : longButSimpleOperandC
יישור למיקום תחילת הטקסט בשורה הראשונה:
? var z = a
: moreComplicatedB
;moreComplicatedC
8. שורות ריקות
:השתמשו בשורות ריקות כדי ליצור "קבוצות" הגיוניות של קוד, למשל
doSomethingTo(x);
doSomethingElseTo(x);
andThen(x);
nowDoSomethingWith(y);
andNowWith(z);
9. שימוש במרכאות
עדיף להשתמש בגרש )'( מאשר במרכאות )"(, זה שימושי כאשר מעוניינים
ליצור stringשכולל קוד :HTML
;'>var myCode= '<canvas id="myCanvas" width="200"></canvas
10. כתיבת הערות
:JSDoc-מומלץ להשתמש ב
/**
* A JSDoc comment should begin with a slash and 2 asterisks.
* Inline tags should be enclosed in braces like {@code this}.
* @desc Block tags should always start on their own line.
*/
/**
* Illustrates line wrapping for long param/return descriptions.
* @param {string} foo This is a param with a description too long to fit in
* one line.
* @return {number} This returns something that has a description too long to
* fit in one line.
*/
