Comments on: 怎样写 pod 文档 http://chunzi.me/post/806 Sun, 05 Sep 2010 02:55:42 +0000 hourly 1 http://wordpress.org/?v=3.0.1 By: chunzi http://chunzi.me/post/806/comment-page-1#comment-2746 chunzi Thu, 19 Nov 2009 07:22:01 +0000 http://chunzi.me/?p=806#comment-2746 是啊，像 ShipIt 之类也可以自动化生成 README。 是啊，像 ShipIt 之类也可以自动化生成 README。

]]> By: agentzh http://chunzi.me/post/806/comment-page-1#comment-2745 agentzh Thu, 19 Nov 2009 06:06:19 +0000 http://chunzi.me/?p=806#comment-2745 我在 Nginx 世界里一般用 mediawiki 的记法写 C 模块的文档，然后再用我自己的 wiki2pod.pl 转成 POD. 例如我的 echo 模块的文档 http://wiki.nginx.org/NginxHttpEchoModule 的 wiki 源码在 http://github.com/agentzh/echo-nginx-module/blob/master/doc/manpage.wiki 而最终生成的 POD 再通过 pod2text 生成纯文本的 README 文件是这样的： http://github.com/agentzh/echo-nginx-module/blob/master/README 不得不佩服 pod 工具链的丰富和完善，哈哈！ 我在 Nginx 世界里一般用 mediawiki 的记法写 C 模块的文档，然后再用我自己的 wiki2pod.pl 转成 POD.

例如我的 echo 模块的文档 http://wiki.nginx.org/NginxHttpEchoModule 的 wiki 源码在

http://github.com/agentzh/echo-nginx-module/blob/master/doc/manpage.wiki

而最终生成的 POD 再通过 pod2text 生成纯文本的 README 文件是这样的：

http://github.com/agentzh/echo-nginx-module/blob/master/README

不得不佩服 pod 工具链的丰富和完善，哈哈！

]]>