Java Recordパラメータを文書化する方法は?


12

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に対してバグレポートを提出しました。

回答:


7

IntelliJバグ/機能がありません

組み込みのJDKツールをjavadocバージョン14-ea以上で使用すると、のJavadocを簡単に生成できますrecord

ここに画像の説明を入力してください

同じために使用されるコマンドは\です

/jdk-14.jdk/.../javadoc --release=14 --enable-preview .../src/main/java/.../CityRecord.java

したがって、これは確かにIntelliJで欠けているものです。(「Javadocの追加」オプションにもコンポーネントが含まれていないため。)

IntelliJの開発の観点から追加する必要があります。もちろん、そのための専任の作業を優先するプレビュー機能も、慎重に検討する必要がある呼び出しです。


1
更新-どうやら、質問者によって報告さたバグはトラッカーで修正されるように受け入れられています。
ナマン
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.