2008-03-31

使用Rdoc生成Ruby API 文档

关键字: rdoc api 文档
rdoc是生成ruby代码api文档的工具，跟javadoc的功能类似，在命令行中输入rdoc，它能够遍历当前目录的ruby源代码文件（以.rb或.rbw为扩展名）进行解析然后生成规范的ruby api文档。可以用rdoc --help来查看具体的命令行参数。rdoc对注释内的特殊标签进行解析并将输出格式化，比如以下一段注释： 

  # 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


"-"：代表缩进的符号列表
"[]"：代表描述列表，方括号内的是被描述的对象，比如这里是cat，跟着的是描述说明，描述说明将换行缩进显示
"<em></em>"：表示文本为斜体
"<b></b>"：表示文本为粗体
"-- ++"：之间的文本不会被解析，也就是在api文档中看不到这段文本
"http:"：文本为超链接
"::"：冒号

具体用法可参考 http://rdoc.sourceforge.net/doc/index.html
后面的图是上述注释生成的文档结果。
  • F9735701-2c97-3217-bbe9-bba6052f1b21-thumb
  • 描述:
  • 大小: 17.9 KB
评论
发表评论

您还没有登录，请登录后发表评论

seemoon
搜索本博客
最近加入圈子
存档
最新评论