주석 작성 방법(?)

Question

/** * &#64;Class Name : test.java * &#64;Description : testClass * &#64;Modification Information * &#64; * &#64; 수정일 수정자 수정내용 * &#64; --------- --------- ------------------------------- * &#64; 2023.01.28 최초생성 * &#64;author JDH &#64;since 2023.01.28 * &#64;version 1.0 * &#64;see */혹시 이런 주석을 여러분들은 사용하시나요?저는 전에 다니던 회사에서 선임 개발자 분한테 이거 없으면 항상 혼나서... 거의 습관처럼 작성하고 최신화 하고 그러는데(ps. 띄어쓰기 , 주석처리 , 폰트크기.. 항상 혼나면서 당시에는 이게 왜 중요하지 그랬는데 지금은 제가 그렇게 하고 없으면 화나고 불안함)다른 분들은 신경 쓰는지 궁금합니다.

defult · Answer

클래스 설명 주석같은데 포멧은 모두 다르지만 비슷하게 적어주는 경우는 많죠.대놓고 IDE같은데서 라이브러리 쓸경우도 클래스나 메소드에 설명나오죠. 어디까지 적어야하는가 얼마나 상세히 적어야하는가 부가적인 기재는 어디까지 하는가는 로컬룰이라 회사 수만큼 나오는 패턴이 됩니다.

Gravatars · Answer

쓸모없다고 생각합니다git은 장식으로 있는게 아닙니다.코드는 명확하게 작성하고 주석은 최대한 줄여야 합니다.

adduci · Answer

버전 관리 도구에 있는 정보를 중복해서 주석으로 작성하면 오히려 가독성에 안좋습니다클래스 마다 이런 주석을 달아놓으면 누군가는 수정 내역을 업데이트 안하게 되고 그럼 주석은 틀린 정보가 되죠클래스 이름도 그냥 클래스 코드만 보면 나오는 내용이구요클래스에 대한 주석은 클래스의 용도 및 목적에 대한 한줄~세줄짜리 주석이 가장 좋습니다

주석 작성 방법(?)

3개의 답변

기타 목록