Javadoc 템플릿 생성기 [닫힘]

문제

저는 Javadoc이없는 큰 코드베이스를 가지고 있고 기본 Javadoc 정보 (예 : 각 메소드의 매개 변수에 @param 쓰기 ...)로 스켈레톤을 작성하는 프로그램을 실행하고 싶습니다.왼쪽.

이에 대한 좋은 해결책을 아는 사람이 있습니까?

수정 :

JAutodoc은 제가 찾던 것입니다.Ant 작업, Eclipse 플러그인이 있으며 템플릿 정의에 Velocity를 사용합니다.

해결책

eclipse 용 JAutodoc 플러그인은 필요한 작업을 정확히 수행하지만 패키지 세분성 :

패키지를 마우스 오른쪽 버튼으로 클릭하고 "멤버 용 javadoc 추가 ..."를 선택하면 스켈레톤이 추가됩니다.

많은 흥미로운 옵션이 있습니다 : javadoc 용 템플릿, 모든 파일의 헤더에 "template javadoc, must be filled ..."등의 TODO 추가.

다른 팁

빈 Javadoc을 자동 생성하는 것은 안티 패턴이므로 권장하지 않습니다.코드가 문서화 된 것처럼 보이게하지만 코드베이스에 노이즈를 추가 할뿐입니다.

대신 javadoc을 실제로 작성할 때 사용할 메서드 별 및 클래스별로 지원하도록 코드 편집기를 구성하는 것이 좋습니다 (한 주석 작성자는이 작업을 수행하는 Eclipse의 기능을 지적했습니다).

JavaDoc을 실행하려는 메소드 위에 커서를 놓고 다음을 입력 할 수도 있습니다. 라코 디스

Enter를 누릅니다.그러면 JavaDoc 스텁이 생성됩니다.

Javadoc이 부족하거나 모든 정보가 없거나 잘못된 정보가있는 javadoc에 대해 경고를 표시하도록 eclipse를 구성 할 수 있습니다.또한 작성할 템플릿을 삽입 할 수도 있습니다.

요청한 도구는 아니지만 놓친 메서드에서 빈 골격으로 끝나지 않기 때문에 더 좋을 것입니다.

작업 공간에 대한 Window> Preferences> Java> Compiler> Javadoc 경로를 넘어서 환경 설정 페이지를 조사하고 편집하여이를 수행 할 수 있습니다.해당 환경 설정 페이지의 스크린 샷은 다음과 같습니다.

소위 Javadoc 환경 설정 페이지

이 화면의 항목에 대한 자세한 내용을 보려면 아래 링크를 따르십시오.

Javadoc을 추가 할

방법을 선택 하고 alt + Shift + j 를 선택하면 자동으로 javadoc이 생성됩니다.댓글.

예 : 라코 디스

Eclipse에서 파일 소스를 마우스 오른쪽 버튼으로 클릭하면 소스 메뉴 아래에 Javadoc 생성 옵션이 있습니다.

라이센스 : CC-BY-SA ~와 함께 속성

제휴하지 않습니다 StackOverflow