开发者

API docs generation tool [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.

We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.

Closed 5 years ago.

Improve this question

I have a RESTful API written on RubyOnRails(restfulie gem). What is the best way to generate 开发者_Go百科api documentation from project sources?


rake doc:app will turn your rdoc formatted comments for your methods into properly formatted html


idlefingers has it right, but here is the complete answer for newbies:

  1. Include rdoc in your Gemfile: gem "rdoc"
  2. Run $ rake doc:app to generate the documentation
  3. Access the rdoc by opening the doc/app/index.html file in your browser
0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜