Как назвать файл js
Обновлено: 06.07.2024
Подключение js-файлов нужно для выполнения в браузере скриптов, написанных на языке JavaScript.
Если в каком-либо шаблоне нужен скрипт, написанный на языке JavaScript, его можно вынести в отдельный js-файл, и дать файлу имя, совпадающее с именем шаблона. Сам файл нужно поместить в папку templates. Больше никаких настроек не требуются – файл будет подключаться автоматически.
Допустим, в шаблоне menu.tpl нужно применять скрипт выпадающего подменю. Создаем файл menu.js со скриптом, который будет подключаться автоматически при каждом выводе блока с шаблоном menu.tpl.
Файл !main.js
По аналогии с файлом !main.css, существует и файл !main.js. В этот файл можно собрать js-скрипты, необходимые для всех страниц.
Правда, такой файл на практике используется редко, так как обычно js-скрипты относятся к шаблонам.
В этот файл рекомендуется помещать уникальные скрипты, созданные именно для данного сайта. Скрипты же из сторонних файлов (например: jquery.js) собирать в файл !main.js не нужно — для этих целей применяйте подключение с помощью метода Blox::addToHead().
Конфликты js-скриптов
Не рекомендуется js-скрипты записывать в html-код (то есть, в шаблоны). Может так случиться, что какой-то шаблон будет назначен на одной странице в двух блоках, и тогда возникнут накладки.Все js-скрипты лучше записывать в js-файлы, как в файлы вида шаблон.js, так и в самостоятельные. Последние нужно подключать с помощью метода Blox::addToHead(). В обоих случаях система будет блокировать вторичное подключение одного и того же файла.
Метод Blox::addToHead() вместе с методом Blox::addToFoot() позволяют гибко управлять очередностью подключения файлов.
Все, что было сказано по поводу очередности подключения css-файлов относится и js-файлам.
См. также
- Подключение js-файлов означает, что в разделе заголовка документа (элемент head), который находится в главном шаблоне, будут автоматически сгенерированы соответствующие html-коды для подключения этих файлов. Сам главный шаблон желательно не редактировать.
- О том, как ссылаться на изображения (логотип, фоновое изображение и т.п.) из js-файлов, читайте в статье "Абсолютные и относительные URL".
Обычно между щелчком мыши по веб-странице и изменением на ней существует некоторая задержка по времени, необходимая, для того чтобы компьютер пользователя отправил запрос на веб-сервер, а затем получил готовую страницу. C помощью JavaScript можно мгновенно вносить изменения в веб-страницу, так как скрипты выполняются тут же на компьютере, а не на сервере. Скрипты могут быть внедрены как в саму страницу (шаблоны), так и записаны в отдельные файлы .js.
Чаще всего JavaScript используют для организации выпадающих меню, предварительной проверки данных форм, небольших интерактивных элементов страницы, разных "красивостей" типа эффекта падающего снега, шлейфа за указателем мыши и т.п.
Каковы правила по именованию файлов в Javascript?
Почему некоторые файлы начинаются с большой буквы, а некоторые с маленькой?
Как таковых правил и рекомендаций по именованию файлов не встречал. Но есть некоторые рекомендации, которых я стараюсь придерживаться во время именования файлов в JavaScript:
- Более привычно использовать имена файлов в нижнем регистре (лично для меня и всех проектов, в которых я веду работу).
- Не использовать пробелы в именах файлов, лучше использовать тире или точку. Использовать тире, когда слова связаны по смыслу, к примеру имя продукта в два слова через тире.Точку, когда идет разделение логики, к примеру имя модуля и версия - разделим точкой.
- Использовать номера версии в именах файлов, если таковые имеются.
- Использовать в именах файлов пространство имен, имя модуля, тип файла (на примере именования в jQuery). Например: product-name.plugin-version.filetype.js или jquery.plugin-0.1.js
Код должен быть максимально читаемым и понятным. Для этого нужен хороший стиль написания кода.
Хорошие ссылки для ознакомления:
Абсолютно неважно как именовать файлы(не рекомендуется с пробелами), считаю что хорошим тоном является именование файлов по стилю camelCase. Пример : helloWorld.js, goodDay.js
Всегда используйте одинаковые правила кодирования для всех ваших проектов JavaScript.
Соглашения о кодировании JavaScript
Соглашения о кодировании — это руководство по стилю программирования. Они обычно охватывают:
- Правила именования и объявления для переменных и функций.
- Правила использования пробелов, отступов и комментариев.
- Практика и принципы программирования
Правила кодирования безопасное качество:
- Улучшает читаемость кода
- Упростить обслуживание кода
Соглашения о кодировании могут быть документированы правилами для команд, или просто вашей индивидуальной практикой кодирования.
На этой странице описаны общие соглашения о коде JavaScript, используемые html5 css.
Вы также должны прочитать следующую главу "рекомендации" и узнать, как избежать ошибок кодирования.
Имена переменных
В html5 css мы используем camelCase для имен идентификаторов (переменных и функций).
Все имена начинаются с буквы.
В нижней части этой страницы вы найдете более широкое обсуждение правил именования.
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);
Пространства вокруг операторов
Всегда ставьте пробелы вокруг операторов (= +-*/), и после запятой:
Примеры:
Отступ кода
Всегда используйте 4 пробела для отступа блоков кода:
Функции:
function toCelsius(fahrenheit) <return (5 / 9) * (fahrenheit - 32);
>
Не используйте вкладки (таблицы) для отступа. Различные редакторы интерпретируют вкладки по-разному.
Правила операторов
Общие правила для простых инструкций:
- Всегда заканчивайте простой оператор точкой с запятой.
Примеры:
Общие правила для сложных (составных) операторов:
- Поместите открывающую скобку в конец первой линии.
- Используйте один пробел перед открывающей скобкой.
- Поместите закрывающую скобку на новую линию без пробелов.
- Не заканчивайте сложный оператор точкой с запятой.
Functions:
function toCelsius(fahrenheit) <return (5 / 9) * (fahrenheit - 32);
>
Петли:
Условий:
if (time <20) <greeting = "Good day";
> else <
greeting = "Good evening";
>
Правила объекта
Общие правила для определений объектов:
- Поместите открывающую скобку на ту же линию, что и имя объекта.
- Используйте двоеточие плюс один пробел между каждым свойством и его значением.
- Используйте кавычки вокруг строковых значений, а не вокруг числовых значений.
- Не добавляйте запятую после последней пары значение свойства.
- Поместите закрывающую скобку на новую линию без пробелов.
- Всегда заканчивайте определение объекта точкой с запятой.
Пример
var person = <firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
>;
Короткие объекты могут быть записаны сжатыми, на одной линии, используя пробелы только между свойствами, как это:
Длина линии <80
Для удобочитаемости Избегайте строк длиной более 80 символов.
Если инструкция JavaScript не умещается на одной строке, лучше всего ее разбить, после оператора или запятой.
Пример
Соглашения об именовании
Всегда используйте одно и то же соглашение об именах для всего кода. Например:
- Имена переменных и функций, написанные как camelCase
- Глобальные переменные, написанные в верхнем регистре (мы не, но это довольно часто)
- Константы (например, PI), написанные в верхнем регистре
Если вы используете Hyp-кур, camelCase, или ундер_скорес в именах переменных?
Это вопрос, который часто обсуждают программисты. Ответ зависит от того, кого вы спрашиваете:
Дефисы в HTML и CSS:
Атрибуты HTML5 могут начинаться с данных-(данные-количество, данные-цена).
CSS использует дефисы в именах свойств (размер шрифта).
Дефисы можно ошибочно считать попытками вычитания. Дефисы не допускаются в именах JavaScript.
Подчеркивает:
Многие программисты предпочитают использовать подчеркивания (дате_оф_бирс), особенно в базах данных SQL.
Подчеркивания часто используются в документации PHP.
Паскалкасе:
Паскалкасе часто предпочитают программисты C.
camelCase
camelCase используется самим JavaScript, jQuery и другими библиотеками JavaScript.
Не запускайте имена с помощью знака $. Это поставит вас в конфликт со многими именами библиотек JavaScript.
Загрузка JavaScript в HTML
Используйте простой синтаксис для загрузки внешних скриптов (атрибут Type не нужен):
Доступ к элементам HTML
Следствие использования «неопрятных» стилей HTML может привести к ошибкам JavaScript.
Эти два JavaScript-заявления будут давать разные результаты:
var obj = getElementById("Demo")
var obj = getElementById("demo")
If possible, use the same naming convention (as JavaScript) in HTML.
Расширения файлов
HTML-файлы должны иметь расширение .HTML (не .htm).
CSS-файлы должны иметь расширение .CSS .
JavaScript-файлы должны иметь расширение .js .
Использовать имена файлов нижнего регистра
Большинство веб-серверов (Apache, UNIX) чувствительны к регистру имен файлов:
Лондон. jpg не может быть доступен как London. jpg.
Другие веб-серверы (Microsoft, IIS) не чувствительны к регистру:
Лондон. jpg можно получить как Лондон. jpg или Лондон. jpg.
Если вы используете смесь верхнего и нижнего регистра, вы должны быть очень последовательны.
Если вы переходите от регистра к регистру, то даже небольшие ошибки могут нарушить ваш веб-сайт.
Чтобы избежать этих проблем, всегда используйте имена файлов нижнего регистра (если это возможно).
Производительности
Соглашения о кодировании не используются компьютерами. Большинство правил мало влияют на выполнение программ.
Отступы и лишние пробелы не имеют большого значение в небольших скриптах.
Для кода в разработке следует предпочесть удобочитаемость. Более крупные сценарии производства должны быть minified.
Каковы соглашения об именах файлов и папок в большом проекте Node.js?
Должен ли я использовать заглавные буквы, верблюжий случай или занижение?
Т.е. это считается действительным?
Очень субъективно, ваша структура каталогов принадлежит вам. Лично мне нравится camelCase, потому что именно этим я и занимаюсь в JS @Chad - в Node.js require принимает строку каталога в качестве параметра, поэтому она не полностью ваша. т.е. require('../app/controllers/someThings'); Node не указывает никаких предложений или стандартов для именования модулей, при условии, что они являются действительными именами файлов / каталогов и не пытаются переопределить имена основных модулей . Для собственных модулей он использует сочетание сокращенного ( fs ), однословного ( events ), подчеркнутого ( child_process ) и строчного ( querystring ). @Rudiger Итак? Вы можете указать любую строку, которую хотите, и структуру каталогов, которую вы можете иметь (при условии, что ваши имена являются допустимыми именами файлов). Из того, что я могу судить по большему количеству ключевых проектов, таких как имена файлов мокко, такие как captain-awesome-file.js, кажется, достаточно распространенным. По крайней мере, это то, что я собираюсь использовать!После нескольких лет работы с node я могу сказать, что нет никаких соглашений о структуре каталогов / файлов. Однако большинство (профессиональных) экспресс-приложений используют такие настройки, как:
Примером, который использует эту настройку, является nodejs-starter .
Я лично изменил эту настройку на:
На мой взгляд, последний лучше соответствует структуре каталогов в стиле Unix (тогда как первый немного смешивает это).
Мне также нравится этот шаблон для разделения файлов:
Lib / index.js
Библиотека / статический / index.js
Это позволяет аккуратно отделить весь исходный код, не беспокоясь о зависимостях. Действительно хорошее решение для борьбы с неприятным Javascript. Реальный пример рядом , который использует эту установку.
Обновление (имена файлов):
Что касается имен файлов наиболее распространенных являются короткими , в нижнем регистре имен файлов. Если ваш файл можно описать только двумя словами, в большинстве проектов JavaScript в качестве разделителя используется символ подчеркивания.
Обновление (переменные):
Что касается переменных, применяются те же «правила», что и для имен файлов. Однако прототипы или классы должны использовать camelCase .
Многие начинающие веб-программисты, когда они начинают изучать Javascript, сталкиваются с проблемой:
Как создать файл с расширением js, в котором будет размещаться javascript код?
Помню, как я тоже на первых порах столкнулся с этой проблемой. Такой вопрос может возникать из-за непонимания того, что собой представляет Javascript код.
В первую очередь, нужно понимать, что javascript – это обычный текст, который написан по определенным правилам. Соответственно, храниться этот текст тоже должен в текстовом документе.
Единственное отличие этого текстового документа от простого текстового файла – это его расширение. Javascript файлы имеют расширение *.js.
Таким образом, вся задача состоит в том, чтобы создать текстовый документ и изменить его расширение.
Хочу рассказать о тех способах создания файла с расширением js, которыми я сам лично пользуюсь.
Все мои уроки по Javascript здесь.
Способ 1. Создание файла js из обычного текстового документа.
Открываем программу «Блокнот», которая входит в стандартный пакет операционной системы Windows.
Если у вас этой программы нет, то можете воспользоваться другим текстовым редактором.
Создаем новый документ и сохраняем его, выбрав в главном меню команду «Файл-сохранить как…»
После того, как файл будет сохранен, нужно открыть папку, где вы его сохранили и переименовать файл, изменив его расширение на js.
Если расширение файлов у вас не отображается, то здесь можно почитать, как его можно включить.
После этой операции, файл для работы с Javascript готов.
Способ 2. Создание файла js в редакторе кода Dreamweaver.
Этим способом я пользуюсь намного чаще, по причине того, что это просто быстрее и удобнее. Создать файл js можно с помощью универсального редактора кода Dreamweaver.
Имейте в виду, что Dreamweaver – это далеко не единственная программа, которая на это способна. Очень многие редакторы кода тоже позволяют также создавать файлы с расширением js.
При первом запуске программы, появляется следующее окно, в котором можно выбрать, что мы хотим создать документ js.
Выбираем его и сохраняем документ.
Если такое окно приветствия у вас не открылось, то можно воспользоваться главным меню «Файл – Создать новый документ» и выбираем «Javascript».
Если у вас возникнут какие-то вопросы или проблемы с созданием, файлов js таким способом, прошу написать об этом в комментариях.
Читайте также: