タグ付けされた質問 「javadoc」

JavaDocを使用して、クラスの最後の静的フィールドの値をどのように参照できますか？ 私が欲しい???、この例では、フィールドの値に置き換えSTATIC_FIELD。 /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the value with {@value} here, * but how do we reference it in the class JavaDoc? */ public static final String STATIC_FIELD …

96 java  documentation  javadoc 

プロパティとゲッターとセッター（DTOスタイル）のみを保持する「単純な」POJOクラスのプロパティ/メンバーのjavadocを作成するときに、ジレンマに遭遇することがよくあります。 1）プロパティのjavadocを記述する か... 2）ゲッターのjavadocを記述します プロパティにjavadocを記述した場合、後でコード補完を介してPOJOにアクセスすると、IDE（Eclipse）は（当然）これを表示できません。また、getter-javadocを実際のプロパティjavadocにリンクできる標準のjavadocタグはありません。 例： public class SomeDomainClass { /** * The name of bla bla bla */ private String name; /** * @return INSERT SOME SMART JAVADOC TAG LINKING TO name's javadoc */ public String getName() { return name; } したがって、基本的には、Eclipse IDEにgetterのjavadocプロパティの説明を表示させるために、他の人がどのように実行するかを聞くことは興味深いことです。javadocコメントを複製する必要はありません。 今のところ、プロパティではなくゲッターのみをドキュメント化するように練習することを検討しています。しかし、それは最善の解決策ではないようです...

93 java  javadoc 

EclipseからIntellijIdeaに移行しています。私がまだ理解できなかったことの1つは、@authorJavaDocタグのオートコンプリートです。@aEclipseで入力する場合、2つの提案があります。 @author - author name @author Intellijで最初の提案を達成するにはどうすればよいですか（それも可能ですか？）？また、可能であれば、作成者名のプレースホルダーに挿入されるもののテンプレートを変更するにはどうすればよいですか？

93 intellij-idea  javadoc 

コード（Javadoc）の文書化の一環として、深いインデントを使用して要素間の関係を示したいとします。 ネストされたリストを次のように作成するにはどうすればよいですか？ いくつかの要素 他の要素 まだいくつかの他の要素

88 documentation  javadoc  indentation  nested-lists 

JavaDocリファレンスを調べましたが、@see（さまざまなリンク）と{@inheritDoc}（スーパークラスJavaDocコメントのエクスポート）の基本的な違いは理解していますが、実際にどのように実装されているかを明確にする必要があります。 Eclipse IDEで、継承されたメソッドに「要素コメントの生成」を選択すると（インターフェイスから、またはtoString（）オーバーライドなど）、次のコメントが作成されます /* (non-Javadoc) * @see SomeClass#someMethod() */ 私はそのままにしておく必要があります私は農産物のJavaDocを必要としていた場合は、交換する@seeと{@inheritDoc}、またはそれを回し善意などのJavaDoc： /** * {@inheritDoc} */ それを行うときでも、class＃methodフラグを保持する必要がありますか？

87 java  javadoc  comments 

独自の列挙型を含むクラスのjavadocを作成しています。個々の列挙型のjavadocを生成する方法はありますか？たとえば、今私は次のようなものを持っています： /** * This documents "HairColor" */ private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED }; ただし、これは全体としてすべての列挙型を文書化するだけです。 各HairColor値を個別に文書化する方法はありますか？列挙型を独自のクラスに移動したり、列挙型から変更したりせずに？ 助けてくれてありがとう。

83 java  enums  javadoc 

私は、署名だけが異なる同じ名前のメソッドを多数使用してAPIを開発していますが、これはかなり一般的だと思います。ユーザーが指定したくない場合にデフォルトでさまざまな値を初期化することを除いて、これらはすべて同じことを行います。消化しやすい例として、 public interface Forest { public Tree addTree(); public Tree addTree(int amountOfLeaves); public Tree addTree(int amountOfLeaves, Fruit fruitType); public Tree addTree(int amountOfLeaves, int height); public Tree addTree(int amountOfLeaves, Fruit fruitType, int height); } これらすべての方法で実行される基本的なアクションは同じです。森の中に木が植えられています。私のAPIのユーザーがツリーの追加について知っておく必要のある多くの重要なことは、これらすべてのメソッドに当てはまります。 理想的には、すべてのメソッドで使用される1つのJavadocブロックを記述したいと思います。 /** * Plants a new tree in the forest. Please note that it may take …

82 java  javadoc 

よくある質問のような質問で申し訳ありませんが、答えが見つかりません。 私がEclipseを覚えている限り、Javadocコメントの空白行は（ソース内のJavadocポップアップで）改行として（余分な垂直方向の間隔で）表示されます。 ただし、Netbeansではそうではありません。 空白行を改行として解釈するようにJavadocを設定できますか？ 追加の質問：ソース内のJavadocポップアップのデフォルトのNetbeans動作（これに関連する）をオーバーライドできますか？ 私が話しているのは： ソース /** * Paragraph One * * Paragraph Two */ void someMethod() { } Eclipseの解釈 Paragraph One Paragraph Two Netbeansの解釈 Paragraph One Paragraph Two

81 java  netbeans  comments  javadoc 

クラスにカーソルを合わせると、jarファイルに含まれているjavadocコメントが日食で表示されるようにしたいと思います。 たとえば、JODA-2.0をダウンロードすると、次の3つのjarファイルが取得されます。 joda-time-2.0 joda-time-2.0-javadoc joda-time-2.0-sources（http://sourceforge.net/projects/joda-time/files/joda-time/2.0/joda-time-2.0-dist.zip/download） 日食では、[プロジェクトを右クリック->プロパティ-> Javaビルドパス->ライブラリ-> JARの追加...]はjoda-time-2.0.jarのプロジェクト（これらのクラスを参照できます）にバイナリを含めます。 しかし、他の2つのjarファイルに含まれているsources / javadocコメントにリンクして、これらのクラスにカーソルを合わせるとjavadocが表示されるようにするにはどうすればよいですか？ 他の2つのjar（joda-time-2.0-javadoc.jarおよびjoda-time-2.0-sources.jar）をビルドパスに追加しても、javadocまたはソースはリンクされません。

80 java  eclipse  jar  javadoc 

閉まっている。この質問は、StackOverflowのガイドラインを満たしていません。現在、回答を受け付けていません。 この質問を改善したいですか？質問を更新して、スタックオーバーフローのトピックになります。 6年前に閉鎖されました。 この質問を改善する それに直面しましょう：デフォルトのJavadocが見苦しいことを確認するために、デザイナーである必要はありません。 Web上には、スタイルを変更したJavadocを提供するリソースがいくつかあります。ただし、デフォルトの動作は製品を表しており、適度に見栄えがよいはずです。 もう1つの問題は、Javadocの使いやすさが他の同様のリソースと比較して最新ではないという事実です。 特に巨大なプロジェクトは、Firefoxのクイック検索を使用してナビゲートするのは困難です。 実用的な質問： ブラウザよりも使いやすい方法で既存のJavadocを参照できるスタンドアロン（デスクトップ）アプリケーションはありますか？ Monoのドキュメントブラウザのようなものを考えています。 理論的な質問： Javadocを何らかの形で標準化された方法で進化させる計画があるかどうか、誰か知っていますか？ 編集： このトピックに関するSunのwikiへの便利なリンク。

80 java  documentation  javadoc 

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. （他のフォーラムで提案されているように）ソースのバージョンを1.8に変更せずにjavadocを機能させることができた人はいますか？私はJDK v11.0.5を使用していますが、問題はまだ存在しています（JDK 12+でも）。 編集：このエラーはmavenから発生し、maven-javadoc-pluginによってスローされました。設定を行ってもJDK 11+で機能させることができませんでした<source>8</source>。

13 java  maven  javadoc  java-11  maven-javadoc-plugin 

Java Recordパラメータをどのように文書化するのですか？最終的にコンストラクターのパラメーター、クラスフィールドになるパラメーターについて言及しています。 私は試した： /** * @param name the name of the animal * @param age the age of the animal */ public record Animal(String name, int age) { } しかし、IntelliJ IDEAは@paramsにエラーとしてフラグを立てます。これがどのように機能するかを示すオンラインの例が見つかりませんでした。私が見つけた最も近いディスカッションはhttps://bugs.openjdk.java.net/browse/JDK-8225055です。 私はいくつか見つかったユニット テスト、これは作業しなければならない意味するように思われるJDKでを。おそらくこれはIDEのバグですか？ OpenJDK 14 + 36-1461、IDEA 2020.1を使用しています。 念のため、IDEAに対してバグレポートを提出しました。

12 java  intellij-idea  javadoc  java-14  java-record