rdoc是Ruby自动生成文档的工具。rdoc生成的帮助文件是HTML格式的,rdoc提供“-fchm”命令参数生成chm文档。做成chm模式便于搜索。rdoc寻找的注释文档格式比较简单,主要搜索method、class、模块上紧接的注释行,rdocParser会搜索rb文件中每一处符合条件的注释,并且认为它们是用于生成文档的注释。
目前该项目已经集成到Ruby项目中,无需单独下载。
rdoc是Ruby自动生成文档的工具。rdoc生成的帮助文件是HTML格式的,rdoc提供“-fchm”命令参数生成chm文档。做成chm模式便于搜索。rdoc寻找的注释文档格式比较简单,主要搜索method、class、模块上紧接的注释行,rdocParser会搜索rb文件中每一处符合条件的注释,并且认为它们是用于生成文档的注释。
目前该项目已经集成到Ruby项目中,无需单独下载。
评论