Соглашения о кодировании jQuery

Question

Я искал некоторые соглашения о кодировании jQuery, но действительно нашел исчерпывающий список.

Например, как мне назвать id моих html-тэгов, мне нравится первый, потому что он соответствует моему соглашению css, но доставит ли мне неудобства в некоторых senarios?

<div id="comment-list"></div>
<div id="commentList"></div>
<div id="CommentList"></div>

А более предпочтительны одинарные или двойные кавычки $ ('# obj') по сравнению с $ ("# obj")?

Также, скажем, я использую один глобальный файл, должен ли я окружить весь мой код следующим, чтобы избежать конфликта знаков $, если бы я использовал другие js libs?

(function ($) {
   $(document).ready(function () {
     ...
   });
})(jQuery);

Должен ли я использовать больше файлов js или поместить все в один глобальный файл?

и т.д.. Каковы некоторые из ваших соглашений, следуя которым, вы упростили кодирование в jQuery для большого проекта?

Answer 1

Я всегда использую ваше предпочтительное соглашение css и использую jQuery для этих элементов без каких-либо проблем. С точки зрения одинарных / двойных кавычек - я использую одинарные кавычки только тогда, когда значение содержит разметку HTML. т.е.

$("#el").html('<div class="wrap">Hey!</div>');

Я заметил, что вы обновили свой вопрос после того, как я ответил на него.

Для конфликтов между библиотеками вы можете использовать библиотеки в режиме совместимости. Например:

var $j = jQuery.noConflict();
$j(document).ready(function () {
   $j("body").css('background', 'red');
});

Что касается использования одного / нескольких файлов, то на самом деле все сводится к чистоте и производительности.

Каждый новый файл .js потребует дополнительного запроса к серверу, что замедляет работу вашего сайта. Но если бы вы написали 5000 строк кода, которые делали бы много разных вещей, вы наверняка могли бы рассмотреть возможность их организации в несколько файлов.

Однако в этих случаях я предпочитаю разделять свои скрипты в своей среде разработки, а затем объединять их в один файл global.js, который я затем сокращаю для производства.

HTH, Марко

Answer 2

В HTML, XML, CSS и URL-адресах имена, состоящие из нескольких слов, обычно «разбиты» (где слова разделяются тире).В этих случаях дашеризация собственных имен из нескольких слов больше всего соответствует контексту.

<div id="comment-list">...</div>

В JavaScript одинарные и двойные кавычки идентичны.Выберите наиболее естественный способ сделать это, но будьте последовательны в этом.

Вы должны писать свой код аккуратно - в нескольких файлах.При разработке и тестировании используйте несколько файлов.Для производственных (и промежуточных сайтов) вы можете объединять и минимизировать свои файлы JavaScript и CSS.Рекомендуется использовать вспомогательную функцию для записи HTML-ссылки на эти сценарии и таблицы стилей, но она достаточно умна, чтобы использовать несколько файлов при разработке и тестировании, а также обработанные файлы в работе.

<%= javascript "jquery", "jquery-ui", "application", "users-page" %>

Answer 3

Обычно я использую -s в именах классов и _s в идентификаторах.