[java] Java 레코드 매개 변수를 문서화하는 방법은 무엇입니까?

Program / 글쓴이

Java 레코드 매개 변수를 어떻게 문서화해야 합니까? 생성자 매개 변수, 클래스 필드가되는 매개 변수를 말합니다.

나는 시도했다 :

/**
 * @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에 대한 버그 보고서 를 제출했습니다 .

답변

IntelliJ 버그 / 누락 된 기능

내장 된 JDK 도구를 javadoc버전 14-ea이상으로 사용하면에 대한 Javadoc을 쉽게 생성 할 수 있습니다 record.

여기에 이미지 설명을 입력하십시오

동일한 명령은 \

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

따라서 이것은 IntelliJ에서 분명히 누락 된 것입니다. ( ‘Javadoc 추가’옵션에도 구성 요소가 포함되어 있지 않습니다.)

물론 IntelliJ 개발 관점에서 추가 작업을 우선시 하는 미리보기 기능으로 추가 해야합니다.

답변