Использование POD для CSS документации

Question

Я работаю над внешним интерфейсом проекта, который имеет бэкэнд Perl.Файлы CSS становятся довольно большими и сложными, и им нужна некоторая документация и оглавления.

Я просмотрел различные руководства, слайды и сообщения в блогах, где каждый предлагает свой стиль форматирования простого текста.Кажется, что нет хорошего стандарта, что затрудняет перенос, печать и чтение документации.

Так как наша другая документация находится в POD (Обычная старая документация) / perldoc, я подумал, что я мог бы попробовать использовать POD и для CSS, но это выглядит очень необычно и откровенно немного странно .Я попробовал простое:

/*
=pod
...
=cut
*/ 

, и он хорошо читается в perldoc.

Перед запуском мы удаляем все комментарии из наших файлов CSS, чтобы размер не был проблемой.

Есть ли другие практические возражения против документирования CSS с помощью POD?Вы использовали какой-то другой стандарт для документирования своего CSS?

Answer 1

Я нашел CSSDOC , который основан на JavaDoc / DocBlock. Очевидно, это не только я, ищущий стандартный способ документирования расширенных файлов CSS. Это выглядит многообещающе, но, поскольку мы уже используем POD для других частей нашего проекта, имеет смысл использовать его и для CSS.

Это означает, что мы можем создать полную документацию нашего сайта в любом формате, который пожелаем.