Чистота и порядок - превыше всего. Рекомендации к коду

19 февраля 2020

Смысл рекомендаций ниже - избавиться от анархии во время работы над проектом и при отправке клиенту.

Основное

  1. Требования: к каждому проекту предъявляются требования - не стоит их игнорировать и самому решать, что важно, а что не очень. Также надеяться на то, что, вдруг, не заметят. Заметят. И о вас сложиться не самое лучшее впечатление, как минимум о невнимательном и необязательном человеке, а как максимум - человеке, которому безразличны договоренности. Ведь раз взялся за работу - значит принял условия этой работы.
  2. Соблюдение сроков: крайне важно. От вашей работы может зависить работа других людей в команде, так и других проектов компании.
  3. Чистота кода: уважайте других. С вашим кодом могут работать другие разработчики. Не ленитесь ставить табуляцию и пробелы, во всех файлах.
  4. Не берите работы, больше чем можете осилить. Сгоревшие компьютеры, сломавшиеся винтчестеры, конечно же с потерей всех данных, вдург пропавшее электричество или срочный переезд - звучит очень глупо.

Для файлов

  1. Используйте только кодировку UTF-8 и она должна быть обязательно указана как мета-тег в html. Также лучше указать кодировку в css. Проверить сами файлы, какая у них кодировка
  2. Типовые файлы проекта:
    папка img - для картинок /спрайтов
    папка js - скрипты
    папка css - файлы стилей
    папка fonts - шрифты
    файл index.html - название главной. Только так
  3. Для названий файлов должен использоваться только английский алфавит, без пробелов и в нижнем регистре. Если необходимо отделить слова, то используется тире или нижнее подчеркивание.
  4. Внутренние страницы, как правило: catalog.html, item.html, contacts.html, about.html и подобное
  5. Все ссылки на странице должны иметь значение в атрибуте href. Если оно не известно, то ставим #. И получиться у нас <a href="#">link</a>. Тоже самое для значение action в форме. Если оставить пустое значение - при клике откроется системный диск или страница перезагрузится. Смысл сего - не получить глупые вопросы и необоснованные претензии, типа "а почему ссылки не работают и у меня что-то скачет". Экономьте свое время и нервы.
  6. Все комментарии только на английском, никакой кириллицы. Над проектом потом могут работать люди, которые не знают что такое кириллица.
  7. Нименование файлов и классов: только английский и слова должны иметь смысл. Не shapka, а header. Не poloska.png, а line.png
  8. Касательно формата наименования картинок: фоновые изображения, как правило, имеют приставку 'bg', иконки - 'ico'. К примеру, bg-main.png и ico-fb.png.
  9. Формат файлов картинок: фоновые картинки, иконки, все то, что используется в дизайне имеет формат PNG. Но иконки могут быть и SVG для ретина экранов. Все прочие картинки людей, деревьев и тому подобное -  JPG.
  10. И конечно же, не должно быть мусора, то есть, неиспользуемых файлов - ни картинок, ни стилей или скриптов