Конвенції про іменування JavaScript [закрито]

Я знаю, що існує багато суперечок (можливо, не суперечок, але принаймні аргументів) щодо того, яка умова іменування найкраща для JavaScript.

Як ви називаєте свої змінні, функції, об'єкти тощо?

Я залишу свої думки з цього приводу, оскільки я вже не займаюся JS (пару років, тільки), і я просто отримав запит створити документ із умовами іменування, який буде використовуватися в наших проектах на роботі . Тому я дивився (google-ing) навколо, і існує так багато різних думок.

Книги, які я читав на JS, також використовують різні умови іменування самих, але всі вони домовляються про один біт: "Знайдіть те, що вам підходить, і дотримуйтесь цього". Але тепер, коли я так багато читав навколо, я виявив, що деякі інші методи мені подобаються трохи краще, ніж те, до чого я звик.

Я дотримуюся правил коду Дугласа Крокфорда щодо javascript. Я також використовую його інструмент JSLint для перевірки дотримання цих конвенцій.

Як каже Джефф, те, що говорить Крокфорд, - це добре.

Єдиним винятком, за яким я слідую (і я широко бачив), є використання $ varname для позначення об’єкта jQuery (або будь-якої бібліотеки). Напр

var footer = document.getElementById('footer');

var $footer = $('#footer');

Ви можете дотримуватися цього посібника зі стилю Google JavaScript

Загалом, використовуйте functionNamesLikeThis, зміннуNamesLikeThis, ClassNamesLikeThis, EnumNamesLikeThis, methodNamesLikeThis та SYMBOLIC_CONSTANTS_LIKE_THIS.

РЕДАКТУЙТЕ: Дивіться приємну колекцію посібників стилів і стилів JavaScript .

Одне з конвенцій, які я хотів би спробувати, це називати статичні модулі з префіксом 'the'. Заціни. Коли я використовую чужий модуль, нелегко зрозуміти, як я його повинен використовувати. наприклад:

define(['Lightbox'],function(Lightbox) {
  var myLightbox = new Lightbox() // not sure whether this is a constructor (non-static) or not
  myLightbox.show('hello')
})

Я думаю про спробу конвенції, де статичні модулі використовують "the", щоб вказати на їхнє існування. Хтось бачив кращий спосіб, ніж цей? Виглядав би так:

define(['theLightbox'],function(theLightbox) {
  theLightbox.show('hello') // since I recognize the 'the' convention, I know it's static
})

Я думаю, що крім деяких синтаксичних обмежень; міркування конвенцій імен дуже залежать від мови. Я маю на увазі, що аргументи на користь c_style_functions та JavaLikeCamelCase в рівній мірі можуть бути використані і навпаки, це просто те, що користувачі мови, як правило, слідкують за авторами мови.

сказавши це, я думаю, що більшість бібліотек прагнуть приблизно слідувати спрощенню Java CamelCase. Я вважаю, що поради Дугласа Крокфорда досить смачні для мене.

Це індивідуальне питання, яке може залежати від того, як ви працюєте. Дехто любить ставити тип змінної на початку змінної, наприклад, "str_message". А деякі люблять використовувати підкреслення між своїми словами ("my_message"), а інші люблять розділяти їх великими літерами ("myMessage").

Я часто працюю з величезними бібліотеками JavaScript з іншими людьми, тому функції та змінні (крім приватних змінних усередині функцій) повинні почати з назви служби, щоб уникнути конфліктів, як "гостьова книга_місаж".

Коротше кажучи: англійська мова, нижчі регістри, добре впорядковані назви змінних та функцій, на мою думку, є кращими. Імена повинні описувати їх існування, а не бути короткими.