전체 Eclipse 프로젝트에 대해 javadoc 태그를 자동으로 만들 수 있습니까?

Checkstyle은 주석에 실제로 유용한 정보가 포함되어 있는지 여부를 알지 못하므로 마지막으로 Checkstyle을 완화시키는 쓸모없는 주석이 자동으로 생성됩니다. 덧붙여, 나는 많은 방법으로 주석을 쓰는 것이 시간 낭비라고 말하고 싶다. 왜냐하면 메서드와 매개 변수 이름이 아직 전달하지 않은 정보가 없기 때문이다. –

자동 생성 된 JavaDoc은 나중에 고통을 느낍니다. 다른 사람들은 그 방법이 무엇을해야하는지 결코 알지 못하기 때문입니다. 1 년 후 수업을 들여다 보면 알지 못할 것입니다.

혼자서 의견을 남기거나 그 방법을 언급하지 마세요.

우리 회사는 고용주가 javadoc을 추가하도록 checkstyle을 사용하고 있습니다. 일부 고용주는 자신의 방법을 언급하고 무의미한 의견을 입력하는 것을 싫어합니다. 그것들은 쓸데없는 것보다 아무런 코멘트가 없다는 것이 낫습니다.

checkstyle을 사용하면 문서화되지 않은 모든 메소드를 찾을 수 있습니다.

같은 초기화 방법을 문서화하는 데 도움이됩니다 무엇

"초기화는 다른 방법 전에 호출되어야하며 클래스 ActionDummy 초기화"

가 무엇을 말할 낫다 정확히 완료 됨

작업 공급자의 기본 상태를 초기화합니다. 일부 주 변수는 청취자가 을 재정의 할 수 있습니다.

출처

2009-07-16 08:17:53

하지만 JAutodoc 옵션 "자동 생성 된 Javadoc에 ToDo 추가"가 귀하의 (매우 유효한) 우려 사항을 해결할 것 같습니까? 각 생성 된 문서에 대해 javadoc을 편집 한 후에'/ TODO : Auto-generated comment' 행을 삭제해야합니다. – VonC

대부분의 프로젝트에서 유일한 개발자이고 다른 것은 관리자, 건축가, 동료, 테스터, 문서 작가 등 (예, 1 : 5)의 역할을 담당하기 때문에 회사에서 문제가되지 않습니다. – akarnokd

자동 생성 된 Javadoc을 어떤 경우에도 확인해야 할 때 사용해야하는 이유는 TODO –

전체 Eclipse 프로젝트에 대해 javadoc 태그를 자동으로 만들 수 있습니까?

답변

관련 문제