Groovy가 섞여있는 Java 코드베이스가 있습니다.이 코드베이스에는 javadoc이 작성되어 있지 않습니다.javadoc에 본문 주석을 포함 할 수 있습니까?
그러나 대부분의 코드는 신체 전체에 흩어져있는 "구식"설명에 합리적으로 잘 설명되어 있습니다.
우리는 이제 문서화 된 것을 얻는 데 노력하고 있습니다. Javadocs는 이제 예를 들어 정기적으로 생성됩니다. 멈추는 수단으로서, javadoc가 클래스 본체 (또는 함수 등)의 본체를 "긁어 내"모든 코멘트를 "스텁"javadoc에 넣으면 정말 좋을 것입니다.
할 방법이 있습니까?
javadocs는 일반적으로 요소의 목적과 사용법을 설명하고 코드 본문 주석은 구현 세부 정보가 있어야한다는 점에서 좋지 않은 생각입니다.
하지만 반드시해야 할 일은 Java 소스 파일 파서 (타사 또는 사용자 자신)와 함께 작동하는 사용자 정의 doclet을 분명히 작성해야합니다. 처리 된 각 클래스에 대해 먼저 해당 Java 클래스의 소스 파일에서 파서를 실행하고 내부 주석을 수집 한 다음 (표준) 도크 렛에 의해 생성 된 (표준) html을 보강하여 코드 주석을 추가합니다.
결과 javadocs를 합리적인 것으로 만드는 데 도움이되는 가능한 전략은 해당 메소드에 대한 javadoc에 대해 지정된 메소드의 내부 주석을 포함하는 것입니다. 단지 'pre'클로저를 사용하고 일반 javadoc html의 끝에 메소드의 구문 분석 된 주석을 추가하십시오.