1

プラットフォームに依存しないAPIドキュメントを開発するためにどのようなツールがありますか?

私は提案されたAPIを設計中であり、構造化された簡単に編集可能な方法でドキュメントを作成したいと考えています。私が見た答えの多くは基本的に「組み込みの言語固有のドキュメントツールを使用する」でしたが、APIを実装するのではなく、「トップレベル」から設計しているため、これはあまり役に立ちません。APIドキュメント用のCMSを探しています

PBWikiまたはConfluenceを使用するためのいくつかの提案を見てきましたが、バージョン管理の側面は優れていますが、プレーンなWikiが最良のオプションであるとは確信していません。

理論的には、API呼び出し用のCCKとAPIを読み取るためのビューを使用したDrupalビルドですが、これは私が探しているものにとっては少し手間がかかります。

APIドキュメント管理システムはありますか?APIのプラットフォームに依存しないドキュメントを作成および管理するための最良のオプションは何ですか?

これに関連する質問を見てきましたが、まだ満足のいく答えはありません。

4

1 に答える 1

3

どんな構造化テキスト言語でも構いません。私はラテックスを使いますが、troff は古い学校です。

しかし、doxygen などを使用するという提案のポイントを見逃している可能性があります。そうすれば、ドキュメントを書くことは、最終的な実装のための足場を築くことにもなります。さらに良いことに、サンプル ドキュメントは最終的な実際のドキュメントと同じ形式であり、もちろん、ソース管理を使用しますね。したがって、仕様への変更のポット履歴が表示されます。

于 2010-06-28T02:51:54.003 に答える