2011-10-09 2 views
5

Java 프로그래밍 용 IntelliJ IDEA를 사용하기 시작했고 @param 및 @return과 같은 태그 (태그라고 부름)가 표시됩니다. 이러한 태그의 의미는 무엇입니까? IntelliJ는 실제로 코드에 이러한 태그가 없으면 불평합니다!IntelliJ IDEA에서 @param 및 @return과 같은 태그는 무엇입니까?

알아야 할 가장 중요한 것이 무엇이고 그 용도는 무엇입니까?

이 태그에 관한 IntelliJ 문서와 관련된 내용을 찾을 수 없습니다.

+0

코드 또는 댓글에? – stivlo

+0

코드의 주석에서 heh. – InvalidBrainException

+2

필수 태그 및 경고 수준은 구성 가능한 검사입니다. 설정에서 "javadoc"를 검색하면됩니다. –

답변

7

예, 태그라고합니다. 주석에 이러한 태그가 표시되면 메서드의 매개 변수와 반환 값을 문서화해야합니다.

JavaDoc 문서를 생성하기 위해 자동으로 처리 할 수 ​​있습니다. 생성 된 문서는 Java API Documentation과 유사합니다. how to write doc comments for the JavaDoc tool을 참조하십시오.

+0

감사합니다. monkey-see monkey-do를 적용하면 태그의 일반적인 형식이 @ 태그 variable_name_if_any 설명임을 알 수 있습니다. – InvalidBrainException

+1

탭이 아니며 단지 공백입니다. 또한 명시 적으로하기 위해이 태그는 IntelliJ에만 해당되지 않습니다. –

+0

IDE 외부에서 생성 된 코드에는이 태그가 쓸모가 있습니까? 즉, 텍스트 편집기로 작성되고 명령 행에서 컴파일 된 코드입니까? – InvalidBrainException

관련 문제