코드스타일; 주석 앞 또는 뒤에 javadoc을 넣습니까?

코드스타일; 주석 앞 또는 뒤에 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(Idea)의 코드 스타일 템플릿이 잘못된 긍정(@throws가 올바르게 지정되어 있는 경우 경고)과 잘못된 부정(@throws가 지정되어 있지 않은 경우, 그러나 지정되어 있어야 하는 경우)에 모두 실패하는 것은 다른 사람에게 도움이 될 수 있습니다.나는 자바독을 다른 무엇보다 우선시하고 주석과 코드를 우선시한다.

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

언급URL : https://stackoverflow.com/questions/3109950/codestyle-put-javadoc-before-or-after-annotation