使用POD进行CSS文档

时间:2010-10-12 11:03:37

标签: css pod perldoc

我正在研究一个带有Perl后端的项目的前端。 CSS文件变得非常庞大和复杂,并且需要一些文档和目录。

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

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

/*
=pod
...
=cut
*/ 

它在perldoc中读得很好。

在发布之前,我们会删除CSS文件中的所有注释,因此大小不会成为问题。

对于使用POD记录CSS还有其他任何实际意见吗?您是否使用其他标准来记录您的CSS?

1 个答案:

答案 0 :(得分:0)

我发现CSSDOC基于JavaDoc / DocBlock。显然,我不只是在寻找记录高级CSS文件的标准方法。它看起来很有前途,但由于我们已经将POD用于项目的其他部分,因此将CSS用于CSS也是最有意义的。

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