PHP, HTML, Javascript и лучшие практики написания

softwareengineering.stackexchange https://softwareengineering.stackexchange.com/questions/9584

Вопрос

Я понял, что мне нужно написать спецификацию соглашения о кодировании HTML, JavaScript и PHP для себя и моей команды.

В веб-разработке, как и в C++, я определенно фанат отступов и комментариев.

Тем не менее, часто в своей работе я сталкиваюсь с кодом HTML+JavaScript+PHP, который внезапно вызывает головную боль.

Я пытаюсь сделать свой код читабельным, но то, что мне кажется лучше (отступы и комментарии), похоже, не очаровывает моих товарищей по команде, поэтому мне было интересно, есть ли лучшая или, по крайней мере, общая передовая практика при написании «гибридных «Документы, подобные современным веб-страницам, которые день ото дня становятся все более и более сложными.

Я осознаю тот факт, что, возможно, код сегодняшних веб-страниц заложен в некоторой сложности, но мне интересно, существует ли уже хорошее соглашение, касающееся этих аспектов.

Это было полезно?

Решение

Некоторые общие правила, которым я следую:

Общий

  • Отступы составляют 4 пробела.
  • Отступ новых уровней
  • Комментарии составляют < ~ 80 символов от уровня отступа.Если я нахожусь на двух уровнях (8 пробелов), это означает, что длина курсора будет около 88 символов.
  • Используйте многострочные комментарии.Мне больше нравится внешний вид, однако это субъективный точка.
  • Комментируйте сейчас, а не позже, когда вы понятия не имеете, что происходит.
  • Брекеты типа Allman.Это чище и читабельнее. Субъективный.

JavaScript

  • Используйте библиотеку.jQuery особенно хорош.Это устраняет все проблемы с кроссбраузерностью.
  • Поймите, что идентификаторы предназначены для определенных элементов, а классы — для стилей.Идентификаторы не следует использовать более одного раза на странице, и к ним будут прикреплены определенные крючки.Используйте классы для таких вещей, как навигация.
  • Вывод исходного кода в методы.Соблазнительно поместить весь код в bind вызов, однако размещение его в отдельной функции повысит гибкость вашего кода.
  • Используйте функции вместо оценок.Это значит setTimeout(function(){ /* Do something */ }, 1000); вместо setTimeout('doSomething', 1000);
  • Используйте локальные переменные с var.

HTML

  • Семантическая разметка.Используйте соответствующие теги.Не ставь <br />здесь для добавления места, настройки полей и правил CSS.
  • Все теги есть строчные буквы.
  • Все теги должны заканчиваться закрывающим тегом или быть самозакрывающимся.
  • Используйте классы для схожего макета.Имейте пару предопределенных классов, например hide, clear, error, и т. д.
  • Все (включая сценарии) должно войти <head>.Беспокойтесь об оптимизации (перемещение чего-либо), когда это представляет проблему.
  • Внешние таблицы стилей и исходный код JavaScript является обязательным если это не зависит от страницы.

PHP

  • Фреймворки хорошие, рекомендую CodeIgniter.
  • Если вы не хотите использовать фреймворк, попробуйте использовать последнюю возможную версию PHP.(Это означает 5.3).
  • Использовать includes в вашу пользу.
  • Очистить инъекции или использовать готовые заявления.

  • Выполните проверку заранее заданных значений отказоустойчивости.

    $logged_in = false;
if(check_user($user))
{
     $logged_in = true;
     $user = load_user($_SESSION);
}
  • Знайте разницу между одинарными и двойными кавычками.По возможности используйте одинарные кавычки.
  • Не повторяйте HTML.

Другие советы

Держите 3 отдельно.Наименее поддерживаемый код, с которым я имею дело, - это всегда, когда есть какой-то PHP, который повторяет много HTML и JavaScript, возможно, с некоторым количеством SQL, добавленным для наглядности.

Сохранение их всех по отдельности значительно упростит поддержку кода, а также упростит работу, если у вас есть люди, работающие над разными частями приложения, например дизайнер, которому нужно работать только с HTML/CSS.

Есть что почитать для вдохновения:

  • Zend Framework — стиль кодирования PHP :Список практик по написанию PHP-кода maintable (форматирование файлов PHP, соглашения об именах, стиль кодирования:Массивы, строка, класс, метод, например.).
  • Google – руководство по стилю кода :Список практик по написанию JavaScript-кода maintable (Правила:Константы, точки с запятой, вложенная функция..., стиль кодирования:Поля «Именование», «Область», «Строка», «Видимость» и т. д.).

Самый простой способ написать веб-приложение на PHP — это, безусловно, смешать все воедино.Однако, если вы поступите таким образом, вы быстро получите неустранимый беспорядок.

Вот несколько хороших практик:

1) Поместите свой JavaScript в <head> документа (или, еще лучше, в отдельные файлы, на которые есть ссылки в заголовке).Узнайте, как связать прослушиватели событий в событии document.onload, а не разбрасывать их по HTML.(А еще лучше научитесь использовать такую ​​структуру, как Jquery;это сделает ваш JavaScript намного красивее).

2) Найдите шаблоны проектирования, такие как MVC.Вы хотите максимально отделить свою бизнес-логику, написанную на PHP, от HTML.В идеале для создания HTML-страниц вы должны использовать хороший язык шаблонов;по крайней мере, PHP в вашем HTML должен быть кратким - в основном вызов переменных и циклический просмотр списков, созданных где-то еще.

3) Комментарии, отступы...это всего лишь базовые передовые методы программирования.Я склонен позволять длине строки превышать 80 символов, когда пишу HTML, просто потому, что язык чертовски многословен, но это единственная традиционная практика, от которой следует отказаться - если остальная часть команды ведет себя небрежно, им нужно впитать это и сформироваться.

Вот пара интересных моментов:

Javascript:Использовать var при инициализации переменных.

HTML:Включите сценарии в конец файла, чтобы они загружались последними.

PHP:Разделите файлы.Не помещайте все классы в один файл, как вы этого не делаете при обычной разработке на C++.Прокомментируйте как можно больше, а также запишите назначение ваших функций/классов.

Лицензировано под: CC-BY-SA с атрибуция
scroll top