Declaration Has Javadoc Problems

Declaration Has Javadoc Problems 검사는 부정확한 Javadoc 콘텐트를 동반하는 클래스와 클래스 멤버를 검색합니다.

Declaration Has Javadoc Problems 검사는 선언이 Javadoc 텍스트가 선행되는 것에 따라 4 탭으로 나누게 하는 다음 옵션을 가집니다:

Class tab
Scope	None  -  클래스를 위한 어떤 Javadoc 주석도 필요하지 않습니다 Public  -  Javadoc 주석은 public 클래스만을 위해 필요합니다 Package - Javadoc 주석은 public 클래스와 패키지 로컬 클래스를 위해 필요합니다
Required tags	@author  - @author가 필요합니다 @version  - @version 가 필요합니다
Method tab
Scope	None  -  메소드를 위한 어떤 Javadoc 주석도 필요하지 않습니다 Public  -  Javadoc 주석은 public 메소드만을 위해 필요합니다 Protected  -  Javadoc 주석은 public과 Protected 메소드를 위해 필요합니다 Package  - Javadoc 주석은 public, Protected, package local 메소드를 위해 필요합니다 Private  -  Javadoc 주석은 for public, protected, package local, private 메소드를 위해 필요합니다
Required tags	@return  -  @return 태그는 리턴 타입이 void 보다 다른 메소드를 위해 필요합니다. @param  -  @param 태그는 각 매개 변수를 위해 필요합니다 @throws  또는  @exception  -  @throws 또는 @exception 태그는 메소드 시그너쳐에 던져지는 것에 따라 선언된 각 예외를 위해 필요합니다
Field tab
Scope   범위	None -  필드를 위한 어떤 Javadoc 주석도 필요하지 않습니다 Public  -  Javadoc 주석은 public 필드만을 위해 필요합니다 Protected  -  Javadoc 주석은 public 과 protected 필드를 위해 필요합니다 Package  -  Javadoc 주석은 public과 Protected, package local fields를 위해 필요합니다 Private  -  Javadoc 주석은 public, protected, package local, private필드를 위해 필요합니다
Inner class
Scope   범위	None  -  내부 클래스를 위한 어떤 Javadoc 주석도 필요하지 않습니다 Public  -  Javadoc 주석은 public 내부 클래스만을 위해 필요합니다 Protected  -  Javadoc 주석은 public 과 protected 내부 클래스를 위해 필요합니다 Package  -  Javadoc 주석은 public과 Protected, package local fields를 위해 필요합니다 Private  -  Javadoc 주석은 public, protected, package local, private내부 클래스를 위해 필요합니다

만일 Declaration Has Javadoc Problems 체크 박스가 선택되고 Inspection 이 어떤 문제를 찾으면, Inspection 툴 윈도우는 Javadoc가 감지한 문제가 있는 곳의 메소드/클래스/필드를 보여주는 Javadoc 탭을 표시합니다.

검사에 의해 발견된 문제를 위한 어떤 사전 정의의 솔루션도 있지 않습니다.

사용 예

다음 클래스를 보십시오:

public class AClass {
 
 /**
 *
 * @param m_str
 * @param m_int
 */
 public void myMethod(String m_str, int m_int, MyAdapter myAdapter) {
 //some code here
 }
}

Inspection 이 AClass 에 적용되고 난 후에, 다음의 툴 윈도우가 나타날 것입니다.



Inspection 은 몇 개의 Javadoc 요구 사항이 부합하지 않았다라고 지적합니다.  특히, 클래스는 어떤 필요한 Javadoc도 가지지 않습니다, 메소드는 missed 태그를 갖고 메소드 설명에 어떤 기간도 있지 않습니다.

---