即時搜索支持以下功能的文檔框架:的Rails問題的REST API文檔
- 從代碼生成的註釋
- 檢索
- 造型定製
- NTH:鏈接引用(如果我引用類的某處類名稱應鏈接到類文檔)
我想要使用它記錄的問題的REST API我正在
我知道YARDoc,但會很高興地收集一些替代
即時搜索支持以下功能的文檔框架:的Rails問題的REST API文檔
我想要使用它記錄的問題的REST API我正在
我知道YARDoc,但會很高興地收集一些替代
馬特·西爾弗曼創造了什麼是可用那裏現在從代碼gen'ing文檔一個非常全面的清單。
http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html
除了院子裏,你可以用下面的rake任務生成RDOC項目文檔:
rake doc:app
在此之後,您的文檔將位於doc/app
文件夾中,您可以通過在瀏覽器中打開index.html
文件來查看文檔。它將包括(當前可能是通用的)doc/README_FOR_APP
文件。
希望這有助於:)
謝謝,這真的很有用:) – MaThGo