1

次の機能をサポートするドキュメント フレームワークを探しています。

  • コード コメントから生成
  • 検索可能
  • カスタマイズ可能なスタイリング
  • NTH: リンクされた参照 (どこかでクラスを参照する場合、クラス名はクラスのドキュメントにリンクする必要があります)

作業中の RESTfull API を文書化するために使用したい

私はYARDocについて知っていますが、いくつかの代替案を集めるといいでしょう

4

2 に答える 2

1

Matt Silverman は、コードからドキュメントを生成するために現在利用できるもののかなり包括的なリストを作成しました。

http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html

于 2013-04-09T21:06:13.417 に答える
0

YARD とは別に、次の rake タスクを使用して RDOC プロジェクト ドキュメントを生成できます。

rake doc:app

この後、ドキュメントはフォルダーに配置され、ブラウザーでファイルをdoc/app開いて表示できます。index.html(現在はおそらく一般的な)doc/README_FOR_APPファイルが含まれます。

お役に立てれば ：）

于 2013-04-09T15:17:08.867 に答える