익명 객체의 함수를 적절하고 유용하게 문서화하는 가장 좋은 방법은 무엇입니까? 나는 (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의 메서드를 무시하는 것처럼 보입니다. 실제로는 문서화를 위해 각 핸들러에 대해 별도의 클래스를 작성하고 싶지는 않습니다.
의사 소통의 대상은 누구입니까? 외부인 인 경우이 메서드는 http://stackoverflow.com/a/8797414/348975에서 설명한대로 설명서가 필요하지 않습니다. 내부자라면 소스 코드를 직접 읽을 수 있습니다. – emory