Просмотр кода
Название: Руководство по оформлению HTML/CSS кода
Описание: Это руководство описывает правила для оформления и форматирования HTML и CSS кода. Его цель — повысить качество кода и облегчить совместную работу и поддержку инфраструктуры. Это относится к рабочим версиям файлов использующих HTML, CSS и GSS Разрешается использовать любые инструменты для минификации компиляции или обфускации кода, при условии, что общее качество кода будет сохранено.
Добавил:
wearnings
Дата: 21 дек 2019, в 8:58
Комментарии (1)
Описание: Это руководство описывает правила для оформления и форматирования HTML и CSS кода. Его цель — повысить качество кода и облегчить совместную работу и поддержку инфраструктуры. Это относится к рабочим версиям файлов использующих HTML, CSS и GSS Разрешается использовать любые инструменты для минификации компиляции или обфускации кода, при условии, что общее качество кода будет сохранено.
Протокол
Не указывайте протокол при включении ресурсов на страницу.
Опускайте название протокола (http:, https:) в ссылках на картинки или другие медиа-ресурсы, файлы стилей или скрипты, конечно, если эти файлы доступны по обоим протоколам.
Отсутствие протокола делает ссылку относительной, что предотвращает смешивание ресурсов из разных протоколов и незначительно уменьшает размер файлов.
Не рекомендуется:
<script src="http://www.google.com/js/gweb/analytics/autotrack.js"></script>
Рекомендуется:
<script src="//www.google.com/js/gweb/analytics/autotrack.js"></script>
Не рекомендуется:
.example {
background: url(http://www.google.com/images/example);
}
Рекомендуется:
.example {
background: url(//www.google.com/images/example);
}
Общее форматирование
Отступы
Всегда используйте для отступа два пробела.
Не используйте табуляцию и не смешивайте табуляцию с пробелами.
Рекомендуется:
<ul>
<li>Пять
<li>Погулять
</ul>
Рекомендуется:
.example {
color: blue;
}
Регистр
Всегда пишите в нижнем регистре.
Весь код должен быть написан в нижнем регистре: Это относится к названиям элементов, названиям атрибутов, значениям атрибутов (кроме текста/CDATA), селекторам, свойствам и их значениям (кроме текста).
Не рекомендуется:
<A HREF="/">Домой</A>
Рекомендуется:
<img src="google.png" alt="Google">
Пробелы в конце строки
Убирайте пробелы в конце строки.
Пробелы в конце строк не обязательны и усложняют использование diff.
Не рекомендуется:
<p>Что?_
Рекомендуется:
<p>Вот так.
Общие мета правила
Кодировка
Используйте UTF-8 (без BOM).
Убедитесь, что ваш редактор использует кодировку UTF-8 без метки порядка байтов (BOM).
Указывайте кодировку в HTML шаблонах и документах с помощью <meta charset="utf-8">. Опускайте кодировку для сss-файлов: для них UTF-8 задана по умолчанию.
(Вы можете узнать больше о кодировках, и о том, как их использовать, по этой ссылке: Наборы символов и кодировки в XHTML, HTML CSS (англ.).)
Комментарии
По возможности поясняйте свой код, где это необходимо.
Используйте комментарии, чтобы пояснить свой код: что он делает, за что отвечает, и почему используется выбранное решение.
(Этот пункт не обязателен, потому что нет смысла ожидать, что код всегда будет хорошо задокументирован. Полезность комментирования зависит от сложности проекта и может различаться для HTML и CSS кода. )
Задачи
Отмечайте задачи для списка дел с помощью TODO.
Отмечайте задачи с помощью ключевого слова TODO. не используйте другие часто встречающиеся форматы, такие как @@.
Заключайте контакты (имя пользователя или список адресатов) в круглые скобки: TODO(контакт).
Описывайте задачу после двоеточия, например: TODO: Задача.
Рекомендуется:
{# TODO(Ivan Ivanov): Разобраться с центровкой #}
<center>Тест</center>
Рекомендуется:
<!-- TODO: Убрать необязательные теги -->
<ul>
<li>Огурцы</li>
<li>Помидоры</li>
</ul>
Правила оформления HTML
Тип документа
Используйте HTML5.
HTML5 (HTML синтаксис) рекомендуется для всех html-документов: <!DOCTYPE html>.
(Рекомендуется использовать HTML с типом контента text/html. Не используйте XHTML, так как application/xhtml+xml (англ.), хуже поддерживается браузерами и ограничивает возможность оптимизации. )
Валидность HTML
По возможности используйте валидный HTML.
Используйте валидный HTML код, кроме случаев, когда использование не позволяет достичь размера файла, необходимого для нужного уровня производительности.
Используйте такие инструменты как W3C HTML validator (англ.) чтобы проверить валидность кода.
Валидность — это важное и при этом измеряемое качество кода. Написание валидного HTML способствует изучению технических требований и ограничений и обеспечивает правильное использование HTML.
Не рекомендуется:
<title>Проверка</title>
<article>Просто проверка
Рекомендуется:
<!DOCTYPE html>
<meta charset="utf-8">
<title>Проверка</title>
<article>Просто проверка.</article>
Семантика
Используйте HTML так, как это было задумано.
Используйте элементы (Иногда неверно называемые “тегами”) по назначению: заголовки для заголовков, p для абзацев, a для ссылок и т.д.
Это облегчает чтение, редактирование и поддержку кода.
Не рекомендуется:
<div onclick="goToRecommendations();">All recommendations</div>
Рекомендуется:
<a href="recommendations/">All recommendations</a>
Альтернатива для мультимедиа
Всегда указывайте альтернативное содержимое для мультимедиа.
Постарайтесь указать альтернативное содержимое для мультимедиа: например для картинок, видео или анимаций, заданных с помощью canvas. Для картинок это осмысленный альтернативный текст (alt), а для видео и аудио расшифровки текста и подписи если это возможно.
Альтернативное содержимое может помочь людям с с ограниченными возможностями. Например человеку со слабым зрением сложно понять, что на картинке если для нее не задан @alt. Другим людям может быть тяжело понять о чем говорится в видео или аудио записи.
(Если для картинки alt избыточен, или она используется только в декоративных целях в местах, где нельзя использовать CSS, используйте пустой альтернативный текст alt="")
Не рекомендуется:
<img src="spreadsheet.png">
Рекомендуется:
<img src="spreadsheet.png" alt="Spreadsheet screenshot.">
Разделение ответственности
Разделяйте структуру, оформление и поведение.
Держите структуру (разметка), оформление (стили) и поведение (скрипты) раздельно и постарайтесь свести взаимодействие между ними к минимуму.
Убедитесь, что документы и шаблоны содержат только HTML, и что HTML служит только для задания структуры документа. Весь код, отвечающий за оформление, перенесите в файлы стилей, а код отвечающий за поведение — в скрипты.
Старайтесь сократить их пересечения к минимуму, включая в шаблоны минимальное количество файлов стилей и скриптов.
Отделение структуры от представления и поведения помогает облегчить поддержку кода. Изменение шаблонов и HTML-документов всегда занимает больше времени чем изменение файлов стилей или скриптов.
Не рекомендуется:
<!DOCTYPE html>
<title>HTML sucks</title>
<link rel="stylesheet" href="base.css" media="screen">
<link rel="stylesheet" href="grid.css" media="screen">
<link rel="stylesheet" href="print.css" media="print">
<h1 style="font-size: 1em;">HTML Отстой</h1>
<p>Я об этом и раньше где-то читал, но теперь точно все ясно:
<u>HTML - полная фигня!!1</u>
<center>Не могу поверить, что для того чтобы изменить оформление,
нужно каждый раз все переделывать заново. </center>
Рекомендуется:
<!DOCTYPE html>
<title>My first CSS-only redesign</title>
<link rel="stylesheet" href="default.css">
<h1>Мой новый CSS дизайн</h1>
<p>Я читал об этом и раньше, но наконец-то сделал сам:
Использую принцип разделения ответственности и не пихаю оформление в HTML
<p>Как круто!
Ссылки-мнемоники
Не используйте ссылки-мнемоники.
Нет смысла использовать ссылки-мнемоники, такие как —, ”, или ☺, когда все команды в файлах, редакторах используют одну кодировку (UTF-8)
Единственное исключение из этого правила — служебные символы HTML (например < и &) а так же вспомогательные и “неДобавил:
wearnings Дата: 21 дек 2019, в 8:58
Комментарии (1)