Недавно мы перестроили наш сайт, используя принципы OOCSS, которые позволяют действительно модульный способ писать CSS.
Сайт большой и на нем работает множество разработчиков, поэтому я хочу иметь возможность документировать CSS, чтобы модули CSS могли использоваться повторно как можно эффективнее.
Есть ли у кого-нибудь опыт использования автоматизированного инструмента для документирования CSS? Или приспособить другой инструмент документации для использования файлов CSS?
CSS_Doc. Сообщение объясняет это.
И пример комментария документации
/**
* Reset text color and line height.
*/
body {
line-height: 1;
color: black;
background: white;
}
Это реализация в Ruby CSSDOC. Краткое руководство по Начало работы с комментариями CSSDOC
Появился новый инструмент под названием Knyl Stylesheets (KSS), который используется для документации CSS.
http://www.webmonkey.com/2011/12/write-better-css-with-knyle-style-sheets/
Домашняя страница: http://warpspire.com/kss/
Например, http://assets.warpspire.com/images/kss/styleguide-full.png
Так как это по-прежнему довольно высоко по связанным поисковым запросам Google, я предлагаю посмотреть https://github.com/kneath/kss.
Лучший способ документировать CSS для продвижения повторного использования - иметь документ с руководством по стилю. Документ может определять стили, как они должны использоваться, когда они должны использоваться, и приводить примеры (как код, так и графический). Просто комментирование в файле CSS обычно не достаточно хорошее - документ руководства по стилю может включать в себя изображение, показывающее, как выглядит правильный элемент с правильным стилем, применяемым к нему. Вы не можете получить это с помощью простых комментариев.
Еще одним генератором документов CSS является StyleDocco: https://github.com/jacobrask/styledocco
Я работаю над живым справочником стиля css под названием http://kaleistyleguide.com
jsduck также генерирует сексуальные документы для css (а также javscript)
Я только что создал сайт для документации по CSS. Проверьте это:
