一部の関数に関するドキュメントを作成することを検討していますが、ソース コードにドキュメントを記述したくありません。
XML など、従うことができるテンプレートはありますか、またはある種の Javadoc っぽいスタイルのドキュメントを生成できるものはありますか?
2 に答える
3
docbookがありますが、公平を期すために、 docbook は本やマニュアル スタイルのドキュメントに優れています。Web サイトの文書化は行いますが、その Web サイトは javadoc ほど強く相互リンクされていない傾向があります。 これは、Web サイトにレンダリングされた docbook ドキュメントの例です。
Docbook は、現実世界にプレゼンテーションを持たない 1 つの「ソース ドキュメント」と、ソース ドキュメントから構築された正確で最新の情報をすべて含む必要があるいくつかの「レンダリングされたドキュメント」がある場合に優れています。
探しているものを理解するのが難しいのは、主に自分自身がよくわかっていないように見えるためです。Javadoc は、Java コードを文書化する目的で設計された文書であるため、「ソースコードのない文書のような javadoc」は従うのが難しい考えです。おそらく、ドキュメントの主要なセクションについて腰を下ろして考えてみると、アウトライン (使用したいナビゲーションがかなり含まれている可能性があります) が見つかるでしょう。そうすれば、空白があるので、空白を埋めるのがずっと簡単になります。
javadoc エンジンを使用してドキュメントを生成できます。非常に構成可能です。2 種類のプラグインをサポートしています。1 つは追加の「タグ」を追加するためのもので、もう 1 つは追加の「レイアウト」を追加/上書きするためのものです。ただし、これらのタグとレイアウトは、「クラスの前の javadoc コメント」がこのクラスの javadoc を効果的に処理するメソッドを呼び出すなど、Java ソース コード指向になる傾向がある API で動作します。そのため、Java ソース コード (またはそれに非常に類似したもの) がなければ、基礎となる API が間違っています (必要に応じて曲げることができない限り)。
于 2012-10-15T15:30:07.450 に答える
2
おそらく、他のドキュメントの作成にも使用できる API ドキュメント ツールであるDoxygenのようなものを探しているでしょう(たとえば、doxygen のマニュアルは、通常のソース コードなしで Doxygen 自体で作成されています)。
もう 1 つのツールはSphinxで、API ドキュメントやソース コードのないマニュアル (例: Python ドキュメント) にも使用できます。
于 2012-10-15T15:53:54.523 に答える