sHinE
@sHinE
веб-разработчик, php/js/mysql и сопутствующее

Комментирование CSS+HTML: стандарты, утилиты и т.п?

Для языков программирования есть возможность построить документацию на основании комментариев к коду, есть специальные инструменты и стандарты написания этих комметариев.


Вопрос такой — есть ли нечто подобное для HTML/CSS?


Вопрос общий — подойдут и ссылки на стандарты/правила документирования, и ссылки на утилиты (если такие есть в природе), и просто ваши мысли и соображения на эту тему.


Цель — получить документацию по шаблонам и стилям на основании комментариев.

P.S. сам я не верстальщик, поэтому если вы — верстальщик и считаете, что идея бредовая — тоже пишите (желательно с объяснением причин)
  • Вопрос задан
  • 3887 просмотров
Пригласить эксперта
Ответы на вопрос 3
kaluzhanin
@kaluzhanin
Для CSS есть даже проект стандарта: cssdoc и его (неполная) имплементация на ruby: css_doc. Насколько это востребованно, не скажу, но логика подсказывает, что раз этим кто-то занимается, значит это кому-то нужно.

По HTML — информации не имею, да и не думаю, что это нужно. Все-таки в CSS можно указывать, когда применять данный стиль, а HTML говорит сам за себя.
Ответ написан
Комментировать HTML — ИМХО бред. Код должен быть чистый. Другое дело — комментировать шаблоны (т.е. чтоб при рендеринге страницы все комменты удалялись и пользователям показывался чистый HTML)

CSS — аналогично, надо иметь 2 версии: 1-я форматированная, с комментами. 2-я (рабочая) — минимизированная (инструментов хватает) и, по возможности, сжатая.

По вашему вопросу рекомендую прочитать статью Наглядное комментирование вёрстки и комментарии к ней.
Но, опять же, стандартов там нет, там лишь мысли как это сделать поудобней.
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы