rdoc是生成ruby代码api文档的工具,跟javadoc的功能类似,在命令行中输入rdoc,它能够遍历当前目录的ruby源代码文件(以.rb或.rbw为扩展名)进行解析然后生成规范的ruby api文档。可以用rdoc --help来查看具体的命令行参数。rdoc对注释内的特殊标签进行解析并将输出格式化,比如以下一段注释:
[b]"-"[/b]:代表缩进的符号列表
[b]"[]"[/b]:代表描述列表,方括号内的是被描述的对象,比如这里是cat,跟着的是描述说明,描述说明将换行缩进显示
[b]"<em></em>[/b]":表示文本为斜体
[b]"<b></b>"[/b]:表示文本为粗体
[b]"-- ++"[/b]:之间的文本不会被解析,也就是在api文档中看不到这段文本
[b]"http:"[/b]:文本为超链接
[b]"::"[/b]:冒号
具体用法可参考 [url]http://rdoc.sourceforge.net/doc/index.html[/url]
后面的图是上述注释生成的文档结果。
# Just for fun
# - one
# - two
# - three
# [cat] small domestic animal
#
# <em>Italic</em> <b>Bold</b>
#
#--
#Hi, dont doc me please!
#++
# Author:: hihi(http:blog.hihi.com)
def demo_method1(a,b)
end
[b]"-"[/b]:代表缩进的符号列表
[b]"[]"[/b]:代表描述列表,方括号内的是被描述的对象,比如这里是cat,跟着的是描述说明,描述说明将换行缩进显示
[b]"<em></em>[/b]":表示文本为斜体
[b]"<b></b>"[/b]:表示文本为粗体
[b]"-- ++"[/b]:之间的文本不会被解析,也就是在api文档中看不到这段文本
[b]"http:"[/b]:文本为超链接
[b]"::"[/b]:冒号
具体用法可参考 [url]http://rdoc.sourceforge.net/doc/index.html[/url]
后面的图是上述注释生成的文档结果。