开发者

Using POD for CSS documentation

I'm working on the frontend of a project which has a Perl backend. The CSS files are getting pretty big and complicated, and are in need of some documentation and Tables of Contents.

I looked at various guides, sl开发者_StackOverflowides and blog posts where everyone suggest their own style of plain text formatting. There seems to be no good standard, making the documentation difficult to port, print, and read.

Since our other documentation is in POD (Plain Old Documentation) / perldoc I figured I could try using POD for the CSS as well, but this feels very unconventional and frankly a bit weird. I tried a simple:

/*
=pod
...
=cut
*/ 

and it reads fine in perldoc.

Before launch, we strip all comments from our CSS files so size would not be an issue.

Are there any other practical objections to documenting CSS with POD? Have you used some other standard to document your CSS?


I have found CSSDOC which is based on JavaDoc / DocBlock. Apparently it's not only me searching for a standard way of documenting advanced CSS files. It looks pretty promising, but since we already use POD for other parts of our project, it makes the most sense to use it for CSS as well.

That means we can generate a complete documentation of our site to any format we wish.

0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜