2012-01-10 3 views
2

익명 객체의 함수를 적절하고 유용하게 문서화하는 가장 좋은 방법은 무엇입니까? 나는 (API here) 서식지 일부 프로그래밍을하고,이 같이 보입니다 코드가 오전 :익명 객체의 메소드에 대한 Javadoc

/** 
* 
* @return handler that does blah 
*/ 
public static RhsFunctionInterface functionBlah() { 
    return new Kernel.RhsFunctionInterface() { 
     /** 
     * Does blah 
     */ 
     @Override 
     public String rhsFunctionHandler(int eventID, Object data, 
       String agentName, String functionName, String arguments) { 
      return null; 
     } 
    }; 
} 

등의 매개 변수에 대해 무엇을 기대하고, 반환 된 객체의 기능이 무엇을하는지 아는 것이 중요합니다 ., 나는 무엇을 적어야하는지 잘 모른다. 이클립스는 javadoc의 메서드를 무시하는 것처럼 보입니다. 실제로는 문서화를 위해 각 핸들러에 대해 별도의 클래스를 작성하고 싶지는 않습니다.

+0

의사 소통의 대상은 누구입니까? 외부인 인 경우이 메서드는 http://stackoverflow.com/a/8797414/348975에서 설명한대로 설명서가 필요하지 않습니다. 내부자라면 소스 코드를 직접 읽을 수 있습니다. – emory

답변

3

메서드는 인터페이스의 구현이므로 문서가 전혀 필요하지 않으며 해당 인터페이스를 문서화해야합니다. 인터페이스 구현은 그에 따라 동작합니다.

+0

이 특정 인터페이스는 일반 핸들러에 사용됩니다. 핸들러는 프로그래머가 원하는 모든 것을 할 수 있습니다. 이 경우에 –

+1

@ NateGlenn이면 JavaDoc 주석을위한 최적의 위치는 functionBlah 메소드에 있습니다. 이 메소드의 사용자는 익명 클래스를 사용하여 메소드를 구현했는지 여부를 알거나 신경 쓸 필요가 없습니다. – emory

+1

+1 - 클래스에 javadoc 주석이 필요한 경우 익명 클래스가 아니어야합니다. –