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

StackOverflow https://stackoverflow.com/questions/1136035

문제

나는 하나가 사용할 수 있다는 것을 안다 'u003Calt>u003Cshift> J '단일 코드 요소에 대한 태그를 만듭니다 (예 : 클래스 메소드).

그러나 전체 프로젝트의 모든 클래스에 대해 이러한 태그를 자동으로 만들 수있는 방법이 있습니까? 아니면 패키지 또는 클래스 수준에서도?

도움이 되었습니까?

해결책

당신은 보셨습니까? 야우 콥?

다른 팁

내가 아는 한에서는 아니다.

어쨌든 그게 뭐가 좋을까요? 자가 생성 된 Javadoc 의견은 쓸모없는 것보다 나쁩니다. 오히려 내 코드를 혼란스럽게 만들지 않겠고 Javadoc은 의견이없는 경우에도 많은 정보를 제공 할 것입니다.

자동 생성 된 Javadoc은 고통입니다. 다른 사람들은 이제 방법이해야 할 일이 아니며 1 년 후 수업을 볼 때 자신도 알지 못할 것입니다.

방법에 직접 댓글을 달거나 방법에 주석하지 마십시오.

우리 회사는 CheckStyle을 사용하여 고용주가 Javadoc을 추가하도록 강요하고 있습니다. 일부 고용주는 자신의 방법에 대해 의견을 말하고 감각이없는 의견을 입력하는 것을 싫어합니다. 쓸모없는 사람보다 그들의 의견이 없다는 것이 더 낫습니다.

CheckStyle을 사용하면 문서화되지 않은 모든 방법을 찾아서 잘 형식으로 문서화 할 수 있습니다.

다음과 같은 초기 방법을 문서화하는 데 도움이되는 것은 무엇입니까?

"Init는 다른 방법보다 먼저 호출되어야하며 집단 행동을 초기화해야합니다."

정확히 무엇이 수행되었는지 말하는 것이 좋습니다

액션 제공 업체의 기본 상태를 시작합니다. 일부 상태 변수는 청취자가 언제라도 재정의 할 수 있습니다 ....

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top