코드 스타일; 주석 전후에 javadoc을 넣습니까? is a javadoc

가장 중요한 문제는 아니지만 주석 앞뒤에 javadoc 주석 블록을 넣을 수 있다는 것을 알았습니다. 코딩 표준으로 채택하고 싶은 것은 무엇입니까?

/**
 * This is a javadoc comment before the annotation 
 */
@Component
public class MyClass {

    @Autowired
    /**
     * This is a javadoc comment after the annotation
     */
    private MyOtherClass other;
}

답변

주석 앞에는 주석이 클래스에 “포함”되는 코드이기 때문입니다. 공식 문서에서 javadoc 예제를 참조하십시오 .

다른 공식 Java 페이지 에서 찾은 임의의 예는 다음과 같습니다 .

/**
 * Delete multiple items from the list.
 *
 * @deprecated  Not for public use.
 *    This method is expected to be retained only as a package
 *    private method.  Replaced by
 *    {@link #remove(int)} and {@link #removeAll()}
 */
@Deprecated public synchronized void delItems(int start, int end) {
    ...
}

답변

나는 이미 주어진 답변에 동의합니다.

주석은 코드의 일부이며 javadoc은 문서의 일부 (따라서 이름)입니다.

그래서 코드 부분을 함께 유지하는 것이 합리적입니다.

답변

그것은 모두 가독성으로 귀착됩니다. 내 의견으로는 코드가 메소드 / 필드 바로 위의 주석으로 더 읽기 쉽습니다.

답변

코딩 표준 외에, javadoc 도구는 주석 뒤에 주석이있는 경우 javadoc 주석을 처리하지 않는 것 같습니다. 그렇지 않으면 잘 작동합니다.

답변

위의 모든 내용에 동의합니다. RestEasy 스타일을 사용할 때 IntelliJ (아이디어)의 코드 스타일 템플릿이 오 탐지 (@throws가 올바르게 지정된 경우 경고)와 오탐 (@throws가 지정되지 않았지만 반드시 있어야 함) 모두 실패하는 것이 다른 사람들에게 도움이 될 수 있습니다. 주석. 내 javadoc을 다른 모든 것, 주석 및 코드보다 우선합니다.

https://youtrack.jetbrains.com/issue/IDEA-220520 에서 버그 보고서를 참조하십시오.

답변