今天完成了纳品工作,感觉就像刚去厕所爽一把出来。呵呵呵
做Javadoc还好,有我们亲爱的eclipse,但是做rubydoc就麻烦了,本来以为也是蛮简单的事情,不过,在网上几番搜索,不见效果,于是自己亲手操刀,慢慢的实验吧。
先说一下,自己在做的时候的经历:
从早上开始,我就不断的百度,发现根本不靠用,请教高手,高手也懒的理,于是乎,自己动手,丰衣足食。
首先,确保你的电脑上装有ruby的运行环境,如果有,就在cmd中运行rdoc,测试一下是否成功,ok后,开始第一步,按照标准将你的ruby代码注释完整,可以参考一下例子,当然最好在官网上。
第二部,整理你要生成文档的ruby程序,选择你要操作的ruby程序的N个,放在一个包下面。
第三部,打开cmd,找到你刚刚建立好的包,进入下面,然后,敲入rdoc *.rb --charset utf-8,这样保证你的文件不会出现乱码。当然你可以help一下。
如此,这样你就完成了。
当然你在测试rdoc的时候,出现问题,你的ruby环境下面没有rdoc,那么你就必须要下载rdoc,然后运行gem install rdoc.gem,安装完毕,开始第一步。
OK,3Q,今天再补上这一篇,帮助大家解决烦恼。
分享到:
相关推荐
rubydoc.info, 下一代 rdoc.info 站点 RubyDoc.info: 货场Doc服务器RubyDoc.info 是下一代的ruby doc服务器,替换 http://rdoc.info 和 http://yardoc.org/docs 。 这里文档服务器使用,来动态生成项目文档
) 干净的默认模板与您现有的部署很好地集成对于Ruby爱好者-它是用Ruby写的导游如果您阅读此文章,则可能属于以下群组之一: 您想第一次{file:TRY.md试用Doc.js} 您需要更多{file:USE.md信息,如何使用Doc.js} 您...
生成的SDK RubyDoc可用。 用法示例 要调用API,您必须具有访问令牌,该令牌类似于以下示例: ll352u9jujauoqz4gstvsae05 。 您可以在用户界面的帐户>个人设置> API访问中找到访问令牌。 以下是一个简短的示例,向...
简单导航简单导航是一个Ruby库,用于为Rails,Sinatra或Padrino应用程序...RDoc您可以在RubyDoc.info上查阅项目的RDoc。 如果您需要在本地生成RDoc文件,请检出存储库,只需在项目文件夹中调用rake rdoc。 在线演示你c
ZRO:用于Rails的OpenApi 3 JSON-Doc生成器 简洁的DSL,用于为Rails应用程序生成OpenAPI规范3( OAS3 ,以前为Swagger3)JSON文档。 class Api :: ExamplesController < ApiController api :update , 'POST ...
首先,在scripts文件夹中安装用于 Markdown 生成的 Ruby gems: cd scripts bundle install 大多数降价是使用 Ruby 模板生成的。 你永远不应该更新 markdown 文件——而是更新 Ruby 模板文件。 Markdown 是使用...
使用生成文档,文档覆盖或类图 例子 查看以了解如何使用此插件。 通过克隆仓库,运行fastlane install_plugins和bundle exec fastlane test 。 为此插件运行测试 要同时运行测试和代码样式验证,请运行 rake 要自动...
宇航员计划 ProjectArgonauts是用于为IDL生成代码和文档的工具和运行时库。 它的工作方式类似于Protobufs,Cap'n'proto或Flatbuffers等项目的工作方式,不同之处在于它还支持作为头等公民的文档...@doc( " The gender
RocketDocs是API的自动文档生成器。 它旨在与 :rocket: 基于的API,但也可以通过rake任务用作独立的生成器。 这个项目的灵感主要来自 :grapes: 。 所有文档都在注释中完成,因此您的代码不会被无功能用途的代码所...
hologram-github-theme, 一个用于全息图的Github Styleguide启发主题 全息图Github主题这是一个非常简单的Github Styleguide 灵感主题,它是用于trulia全息图的主题,它是 ruby 前端doc生成器。预览 视图示例 style...
prmd JSON Schema工具:从JSON Schema文档中搭建,验证并生成文档。 介绍 提供了一种描述API的好方法。 prmd提供了用于引导这样的...doc :从架构生成文档 render :从架构渲染视图 这是在典型的工作流程中使用这些命
RSpec API文档生成器 为您的Rails API生成漂亮的API文档。 检出一个。 变化 请参阅Wiki以获取最新。 安装 将rspec_api_documentation添加到您的...$ open doc/api/index.html 观看者 考虑添加查看器以增强生成的
SDoc是在RDoc文档生成器之上构建HTML模板,用于Ruby代码。 提供了在安装gem时获得的两个命令行工具: sdoc使用generator=shtml (可搜索HTML)运行rdoc的命令行工具 sdoc-merge命令行工具,用于将多个sdoc文件夹...
您可能想要涵盖的内容: Ruby版系统依赖配置数据库创建数据库初始化如何运行测试套件服务(作业队列、缓存服务器、搜索引擎等) 部署说明… 如果您不打算运行rake doc:app请随意使用不同的标记语言。
您可能想要涵盖的内容: Ruby版系统依赖配置数据库创建数据库初始化如何运行测试套件服务(作业队列、缓存服务器、搜索引擎等) 部署说明… 如果您不打算运行rake doc:app请随意使用不同的标记语言。
您可能想要涵盖的内容: Ruby版系统依赖配置数据库创建数据库初始化如何运行测试套件服务(作业队列、缓存服务器、搜索引擎等) 部署说明… 如果您不打算运行rake doc:app请随意使用不同的标记语言。
该存储库包含AGL文档工具,可从Markdown文件自动生成技术网站。 该工具依赖于 ,建议的脚本很大程度上受启发 该存储库由的docs-webtemplate使用脚本setupdocs.sh处理,请参考该库以初始化doc环境。 正在安装 对...
漂亮医生Pretty Doc是使用漂亮的模板将HTML转换器快速便捷地降价的工具,旨在提供一个简单的工具来生成通用的漂亮docs。 [目录]特征漂亮的内置模板: default , bootstrap , parallel 代码突出显示Markdown TOC...
$ rake doc 并生成API文档。 作者 弗洛里安·弗兰克 许可证¶ ↑ 这是免费软件; 您可以根据自由软件基金会发布的GNU通用公共许可证版本2的条款重新分发和/或修改它: www.gnu.org/copyleft/gpl.html
自述 此自述文件通常会记录... Ruby版 系统依赖 配置 数据库创建 数据库初始化 如何运行测试套件 服务(作业队列、缓存服务器、搜索引擎等) 部署说明 … 如果您不打算运行rake doc:app请随意使用不同的标记语言。