반응형
@see와 @inheritDoc의 차이점 상세
JavaDoc 레퍼런스를 살펴보았는데, 기본적인 차이는 이해하지만,@see(클릭 링크) 및{@inheritDoc}(슈퍼클래스 JavaDoc 코멘트 내보내기), 실제 구현 방법에 대한 설명이 필요합니다.
Eclipse IDE에서 상속된 메서드(인터페이스 또는 toString() 덮어쓰기 등)에 대해 "Generate Element Comments"를 선택하면 다음과 같은 코멘트가 생성됩니다.
/* (non-Javadoc)
* @see SomeClass#someMethod()
*/
JavaDoc을 작성해야 할 경우 그대로 두어야 할 경우 대체@see와 함께{@inheritDoc}또는 다음과 같이 JavaDoc에서 전달합니다.
/**
* {@inheritDoc}
*/
이 경우에도 class #method 플래그를 유지해야 합니까?
먼저 원래 일식 템플릿은 시끄러운 쓰레기에 불과하므로 제거해야 합니다.의미있는 문서를 넣거나 아무것도 넣지 마세요.그러나 IDE 템플릿을 사용하여 명백한 내용을 다시 작성하면 코드가 복잡해집니다.
둘째, javadoc을 작성해야 할 경우 코멘트를 다음과 같이 시작해야 합니다./**그렇지 않으면 javadoc이 아닙니다.
마지막으로, 덮어쓰기를 할 경우 다음을 사용해야 합니다.@inheritDoc(@seh가 코멘트에서 언급했듯이 원래 문서를 복제하는 것만으로는 아무것도 필요 없습니다). @see다른 관련 메서드를 참조할 때만 사용해야 합니다.
언급URL : https://stackoverflow.com/questions/13327534/details-of-difference-between-see-and-inheritdoc
반응형
'IT' 카테고리의 다른 글
| PHP를 사용하여 오류 404 페이지를 만드는 방법 (0) | 2023.02.06 |
|---|---|
| PHP에서 문자열의 일부를 제거하려면 어떻게 해야 합니까? (0) | 2023.02.06 |
| Ng-model이 컨트롤러 값을 업데이트하지 않음 (0) | 2023.02.06 |
| x초마다 메서드/함수를 트리거하는 Vue js (0) | 2023.02.06 |
| JavaScript isset() 등가 (0) | 2023.02.06 |