RDocRuby自动文档工具联合创作 · 2023-10-02 05:37rdoc是Ruby自动生成文档的工具。 rdoc生成的帮助文件是HTML格式的,rdoc提供“-f chm”命令参数生成chm文档。做成chm模式便于搜索。 rdoc寻找的注释文档格式比较简单,主要搜索method、class、模块上紧接的注释行,rdoc Parser会搜索rb文件中每一处符合条件的注释,并且认为它们是用于生成文档的注释。 目前该项目已经集成到 Ruby 项目中,无需单独下载。浏览 6点赞 评论 收藏 分享 手机扫一扫分享 编辑 分享 举报 评论图片表情视频评价全部评论推荐 swammdoc接口文档自动生成工具swammdoc接口文档自动生成工具如图: 团队协作离不开约定,规范,最早我们用word,excel编写接口文档,现在有了开源,涌现了一批接口文档管理平台,rap,小幺鸡,apiManager等等,有swammdoc接口文档自动生成工具swammdoc 接口文档自动生成工具如图: 团队协作离不开约定,规范,最早我们用word,exceSphinx 文档工具Sphinx简单来说,是一个文档生成工具,用于把reStructuredText格式的源文件生成诸如HTML,PDF,LaTex一类的格式。编辑者无须亲自处理文本的格式,程序会自动根据源文件里的设置产JSimpleDocJava文档工具JSimpleDoc是一个用来根据程序源码生成文档的工具,类似JavaDoc,能自动保持跟源码文件的同步。支持PHP、Java编程语言。YardRuby 文档工具YARD是一个Ruby文档生成工具。它使用户能够生成一致的、可用的文档,这些文档可以非常容易地导出为多种格式,并且还支持扩展自定义Ruby结构,如自定义类级定义。特点:1.RDoc/SimpleMareLyXerHTML文档工具eLyXer是一个将lyX文档转成HTML文档的工具,采用Python开发。使用方法:$elyxerdocument.lyxpage.htmlPython.exeelyxerdocument.lyxpdoxmateAPI 文档工具过去通常要自己维护API文档,这会是一件比较蛋疼的事情。所幸我们有dox,dox可以帮我们解析注解。但是dox不能帮我们任意生成文档。于是就有了doxmate,doxmate基于dox的注解对象,加入PhpDocumentorPHP文档工具PhpDocumentor (PHPDoc) 是一个能从PHP代码生成javaDoc样式的API文档PhpDocumentorPHP文档工具PhpDocumentor(PHPDoc)是一个能从PHP代码生成javaDoc样式的API文档和用户指南。doxmateAPI 文档工具过去通常要自己维护API文档,这会是一件比较蛋疼的事情。所幸我们有dox,dox可以帮我们解析注解。点赞 评论 收藏 分享 手机扫一扫分享 编辑 分享 举报