java 주석 어디까지 달아야 하나

Question

java 주석 다는데요한가지는 너저분하고 복잡하니까 주석을 갈략하게 하자두번째는 유지보수를 위해 세세하게 하자 javadoc 기준으로두번째일 경우 언터페이스만 한다? 아니면 클래스 변수 메서드 모든것에 다한다?어떤 방법으로 실무에서는 작성하고 계시나요??제생각에는 두번째가 맞는거 같은데 두번째에서 어디까지 달아야할지 감을 못잡겠습니다.

세브라이드 · Answer

되도록 코드로 모든걸 설명한다.코드로 설명이 되지 않는 부분(예를 들어 기획상 명칭은 class지만 코드상 명칭은 class 약속어를 피하고 추후 추상화를 위해 group으로 했다던가)은 주석을 단다.

강아지좋아하는개발자 · Answer

보통은 API 명세서만 만들고 주석 안다는거 같던데2번 처럼 하는 프로젝트는 일단 본 적 없음..

마마마22636 · Answer

그냥 의도를 간략히 한줄만 적는게 최적입니다. 코드값 표시랑//===================// A그룹의 대한 xxx 출력//===================if ( grpType == '3' ) { // 그룹코드 == A그룹일일이 다 아는것까지 세세하게 몇줄로 주렁주렁다는거 최악입니다.. 유지보수하면서 소스코드 고치다보면 주석 안 고쳐지는게 수두룩하거든요

allinux · Answer

주석 즉 comment 는 최대한 없는 것이 좋습니다. comment 을 적는다는 것 자체가 코드만으로 이해가 어렵기 때문에 별도의 추가 설명이 필요하다라는 의미이므로 바람직하진 못한겁니다.물론 주석말고 java document(javadoc) 은 필요합니다. 이것은 해당 api 를 설명하는 문서로 필요합니다.

김을동 · Answer

자바 기본 클래스들 들어가보세요그정도가 최대라고 보입니다

defult · Answer

자바 클래스 불러오시면 클래스설명, 메소드설명, 전역변수 설명 들어가있고 불러온 사람이 IDE통해서 볼수있죠? 그 수준이 기본적인 주석 작성 영역입니다.그 외에는 대부분 로컬룰에 가까우므로 자신이 속한 그룹에서 정한 룰에 따르실 문제이며 집단마다 다 다른 요구를 할 가능성이 높습니다.다만 주석을 작성하실때 메소드 내부에 내용 하나하나에 주석을 달 일은 없다고 보면 됩니다.

엡실론 · Answer

구글 자바 스타일 가이드를 참조해 봐도 좋을 것 같네요. https://google.github.io/styleguide/javaguide.html#s7.3-javadoc-where-required가이드에는 예외가 있지만, "모든 public class, 그리고 public class의 public 혹은 protected 멤버"에 javadoc을 쓰도록 합니다.우선 1. 다른 사람과 협업이 많이 필요한 부분은 되도록 상세하게, 2. 좀 덜 필요한 부분은 덜 상세하게, 3. 세세한 구현 부분은 헷갈리고 복잡한 경우에만.다른 팀도 사용하는 API 같은건 1번에 해당할 것이고, 2번은 팀내에서만 사용하는 공통 함수 같은 것들, 3번은 코드에서 잘 드러나지 않는 숨겨진 제약 조건 같은게 있을 겁니다. 예를 들자면 int 타입 변수인데 실제로는 0,1,2의 3가지만 가능해서 그걸 전제로 코드를 쓰는 경우가 있을 수 있겠죠. 그럴 땐 그런 조건을 주석으로 남겨두면 다른 사람이 혹은 본인이 나중에 볼 때 좀 더 이해하기 편합니다.

java 주석 어디까지 달아야 하나

7개의 답변

Q&A 목록