代码之家 › 专栏 › 技术社区 › Jacob Rask

将POD用于CSS文档

perldoc pod css

0

Jacob Rask · 技术社区 · 15 年前

我正在一个有Perl后端的项目的前端工作。CSS文件变得相当大和复杂,需要一些文档和目录。

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

由于我们的其他文档位于POD(普通的旧文档)/perldoc中,我想我也可以尝试将POD用于CSS,但这感觉非常不传统,坦率地说有点 奇怪的 .我尝试了一个简单的:

/*
=pod
...
=cut
*/

它在perldoc中读起来很好。

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

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

1 回复 | 直到 5 年前

1

0

Jacob Rask 15 年前

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

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