問題タブ [javadoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
c# - C＃のXMLコメントのドキュメントのようなJavadoc
C＃XMLコメントをドキュメントに変換するための何かを探しています。CHMもMSDNのルックアンドフィールも好きではありません。javadocsを使うのが大好きです。それらはナビゲートしやすく、すべてにアクセスできます。コード内のコメントをルックアンドフィールのようなjavadocに変換するために使用できるツールを探しています。
これを行う何かがありますか？SandcastleとそのさまざまなGUIを試しましたが、私が望むことを実行できません。
eclipse - Eclipse で簡単に JavaDoc をパッケージに追加できますか?
私は javadoc を使用してクラスとメソッドを文書化しています。パッケージにもいくつかの概要情報を追加したいと思います。入力すると、Eclipse がクラスまたはメソッドごとに一致する Doc Comment のスタブを作成する方法が気に入っています/**<Enter>。Eclipse にもpackage.html ファイルを生成する簡単な方法はありますか?
java - jar にソースを含めずに、クラスから javadoc を表示するように Eclipse を取得するにはどうすればよいですか?
ソースなしでパッケージ化する jar ファイルを作成していますが、Eclipse で開発者向けに javadoc を公開したいと考えています。
exception - Javadoc の生成時に BufferOverflowException が発生しますか?
javadoc ツールで java.nio.BufferOverflowException が発生するという問題が発生したことはありますか?
日本語のコメント (charset MS932) を含むコードの Javadoc を生成しようとしています。それが関係しているのではないかと思います。この問題の回避策を知っている人はいますか?
スタックトレースは次のとおりです。
netbeans - ライブラリで定義されている場合でもNetbeansJavadocが見つかりません
Netbeansが外部ライブラリのJavadocを認識しないという問題があります。ライブラリパスに移動し、有効なjavadocパスを指定しました（Netbeansはエラーなしでパスを受け入れます）。ただし、Netbeansを再構築/開いた後でも、ライブラリ内のすべてのアイテムに対して「Javadocが見つかりません」というエラーが発生します。
エラーメッセージが表示されないため、どこに行けばいいのかわからず、Webブラウザを使用してドキュメントを参照できます。何か案は？
NEtbeansのバージョンは6.5.1です。ファイルは、ライブラリのプロパティの[Javadoc]タブに追加されたディレクトリで解凍されます。ライブラリは期待どおりに機能します。
Netbeansキャッシュをクリアして効果がないようにしました。
私はそれを動かしました。ライブラリを削除し、再作成してJavadocを追加しました。今では完全に機能します。
ant - antを使用してタグ付きのjavadocを作成する
{@see myPackage.MyClass}のようなタグを使用して、javadocでJavaソースコードにコメントを付けました。
ターミナルからantを使用してjavadocを生成する必要がありますが、次の警告が表示されます。
build.xmlには、次の行があります。
誰か助けてもらえますか？
編集：
正しく使用しています。たとえば、私は持っています
version - Javadoc のバージョン管理
プロジェクトのバージョン番号付けに少し問題があります。
たとえば、4 つのクラス One Two Three Four があるとします。
このソフトウェアを初めてリリースするときは、バージョン 1.0.0 というラベルが付けられます。
私のJavaドキュメントのコメントでは、すべてのクラスについて、@version 1.0.0として持っています
したがって、テストはクラス2のバグでそれを送り返します
クラス 2 を更新し、バージョン 1.0.1 をリリースする必要があります
すべてのクラスで @version タグを更新する必要がありますか?
それとも、最終的に javadoc コメントに異なるバージョン番号を持つ一連のクラスになってしまうのでしょうか?
java - HTMLからのジャー
私が利用しているサードパーティのライブラリは、JavaDoc HTML と関連する bin ファイルを zip ファイルで提供していました。JavaDoc HTML から jar ファイルを作成するにはどうすればよいですか?
ありがとう。
java - JavaDoc でカスタム タグを使用してビジネス ロジックを文書化しますか?
JavaDoc を使用してカスタム定義タグからメモのリストを作成することは可能ですか? コード全体にフラグを立てたいビジネス ルールがありますが、それは、私が知っている既存のタグのいずれにも当てはまりません。次のようなことをするタグがあったとします。
@note ロジック - このコンテナには 12 個のウィジェットしか持てません
これは一種の制約または要件の逆ドキュメントであり、元の仕様の一部であるとは限らないため、これらをドキュメント化したいと思います。ソースコードでそれを文書化したい理由の1つは、ソースコードが失われることはないように見えるのに対し、設計仕様は... (言うまでもなく、誰もそれらを読んでいないようです)