Rain是一个可生成美观且可定制API文档的宝石,其灵感来自YARD和RDoc。Rain的目标是从混合了Markdown的Ruby注释语法生成漂亮的API文档。这些文档可以内嵌在.rb文件中,或使用单独的.md或.txt文件编写整体架构文档。在API文档的模板和外观方面,Rain允许进行大量自定义,并提供一个简单的基于ERB模板系统。Rain目前仍处于WIP(工作中)阶段,尚未完全稳定。解析、文件读取功能以及模板输出均已完成,但实际的模板布局和样式仍在优化中。安装方式非常简单,只需从rubygems.org安装,执行gem install rain-doc
即可。这将安装gem、raindoc可执行文件及其模板文件。使用Rain的CLI(命令行接口),用户可以轻松生成文档。
Rain受YARD与RDoc启发的Ruby内联API文档工具
文件列表
rain-master.zip
(预估有个34文件)
rain-master
TEMPLATES.md
4KB
img
rain-basic-rb.png
132KB
rain.png
423KB
lib
doc.rb
5KB
rain.rb
2KB
doc_part.rb
4KB
parser.rb
5KB
暂无评论