Я работаю над интерфейсом проекта, имеющего внутренний интерфейс Perl. Файлы CSS становятся довольно большими и сложными и нуждаются в некоторой документации и таблицах содержимого.Использование POD для документации CSS
Я просмотрел различные руководства, слайды и сообщения в блогах, где каждый предлагает свой собственный стиль форматирования обычного текста. Кажется, что нет хорошего стандарта, что затрудняет перенос документации, печать и чтение документации.
Поскольку наша другая документация в POD (Plain Old Documentation)/perldoc Я полагал, что я мог бы попробовать использовать POD для CSS, а также, но это чувствует себя очень нетрадиционный и откровенно немного странно. Я пробовал просто:
/*
=pod
...
=cut
*/
и он отлично читает perldoc.
Перед запуском мы удаляем все комментарии из наших файлов CSS, поэтому размер не будет проблемой.
Есть ли другие практические возражения против документирования CSS с помощью POD? Вы использовали какой-то другой стандарт для документирования своего CSS?
CSS, который документирован * вообще *, является редкостью в моем опыте. Насколько велика «довольно большая» здесь? У меня на моем сайте около 2500 строк CSS, и это не кажется очень большим. – Pointy
Он разделен на несколько файлов, но маловероятно, что он будет расти более чем на 10 тыс. Строк. И это связано с серьезным планированием и оптимизацией. Это очень большой сайт с множеством необходимых исключений для стилизации. –
Я не думаю, что когда-либо сталкивался с моими работами в Интернете, видел любой сайт, какой бы большой он ни был, имея 10 000 строк кода CSS. Какой стиль и почему вы должны обрабатывать исключения? Это для старых браузеров? Вы подтолкнули философию к тому, чтобы предоставить более старым браузерам меньший опыт? Вы построили это наилучшим образом? Рассматривали ли вы такие подходы, как OOCS (http://wiki.github.com/stubbornella/oocss/)? Смотрите видео и слайд-шоу на нем. Мы сократили нашу базу кода CSS на 50-60%, следуя некоторым принципам. –