css - 将 POD 用于 CSS 文档

Question

我正在开发一个具有 Perl 后端的项目的前端。CSS 文件变得非常庞大和复杂，需要一些文档和目录。

我查看了各种指南、幻灯片和博客文章，其中每个人都提出了自己的纯文本格式风格。似乎没有好的标准，使得文档难以移植、打印和阅读。

由于我们的其他文档在 POD（Plain Old Documentation）/perldoc 中，我想我也可以尝试将 POD 用于 CSS，但这感觉非常不合常规，坦率地说有点奇怪。我尝试了一个简单的：

/*
=pod
...
=cut
*/ 

它在 perldoc 中读起来很好。

在发布之前，我们会从 CSS 文件中删除所有注释，这样大小就不会成为问题。

用 POD 记录 CSS 还有其他实际的反对意见吗？您是否使用过其他标准来记录您的 CSS？

Answer 1

我找到了基于 JavaDoc/DocBlock 的CSSDOC 。显然，不仅仅是我在寻找一种记录高级 CSS 文件的标准方法。它看起来很有希望，但由于我们已经在项目的其他部分使用了 POD，因此将它也用于 CSS 是最有意义的。

这意味着我们可以将我们网站的完整文档生成为我们希望的任何格式。