주석 치는 방법? 양? 질문 드립니다.

Question

안녕하세용.코드에 주석 붙이는 중 문득 떠오른 생각이,얼마나 적어야 될까 입니다.제가 신입이라 여기가 첫 회사인데, 주석을 얼마나 쳐야 하는 지 모르겠네요.자세하게 다 쓰자니 덕지덕지 많이 붙어버리고,적게 쓰자니 또 보는데 힘들까봐 고민입니다...기존 프로젝트 코드에 주석이 있긴 한데, 주석이 거의 없더라고요.읽는데 항상 새로운 느낌이 드네요 허허..아무튼 그래서 제가 기준을 정해야 할 거 같습니다.아무튼 저는클래스 위 : 어떤 주제?를 담당하는 클래스인가메서드 선언부 위 : 메서드가 하는 일메서드 내부 객체/변수 생성 or 호출 : 무슨 데이터인가메서드 내부 객체/변수 사용처? : 어떻게 사용되는 중인가메서드 내부 if 분기문? : true라면 어떤 상황이고, false이면 저런 상황이다.추가로 MVC가 아닌 Config 파일들에는 추가로 어떤 용도로 사용 중인지?Jwt는 일반적인 로그인, Redis는 2차 인증 세션용 등등...이 정도로만 적고 있네용...다들 자기들만의 기준이 있으신가요?

js_ · Answer

가장 좋은건 주석이 없는 거라고 생각합니다.예를들어 메소드 선언부 위에 메서드가 하는 일을 주석으로 남긴다고 하셨는데메서드가 하는 일을 메서드 명으로 바로 알 수 있게 메서드 명을 지으면 가장 좋지 않을까요.근데 메서드가 하는 일이 복잡할 수록 명칭으로 알기 쉽게 짓기가 어렵기 때문에 메서드 위에 주석으로 간단한 설명을 넣는 정도는 괜찮은데요if 분기문에 주석을 남기는건 굳이라고 생각합니다. true / false 가 코드에 바로 보이는데 굳이 주석으로 남길 필요가 있나요

catcode · Answer

저는 기억력도 좋지 않고 메소드나 변수명도 바로 알 수 있게 잘 짓지 못합니다. 복잡한 로직이라면 더욱더요.그래서 함수 선언 위에 간단하게 어떤 메소드 인지 적습니다.함수 내부에는 한눈에 들어오지 않거나 나중에 봤을 때 여러군데 확인해야 할 필요가 있다면 주석을 작성합니다.

오리구이 · Answer

주석이 없는 코드는 죽은 코드입니다.유지보수나 동료들이 다시는 안쓰게 되죠. 반듯이 주석은 달아야 하며 간략하게 바로 알수 있게 적어야 합니다.

닉네임이어려워 · Answer

주석이 있던, 없던 사내 룰에 따르면 된다고 생각됩니다.주석이 없다고 좋은코드도 아닐뿐더러, 주석이 있다고 안좋은 코드도 아니에요.(Java 기본 함수들 주석 덕지덕지 엄청 많아요)개인적으로는 클래스, 메서드 2개 정도면 충분하다고 보네요.메서드 내부적으로 어려운건 간단하게 적으면 될것 같습니다.

샤르르 · Answer

자신의 코드를 6개월 뒤에 봤을때 이해가 안된다면 주석을 쳐야 합니다. 🤣 주석은 다시 추적하는데 도움을 줍니다

샘톨 · Answer

개인적인 의견입니다. 각 언어마다 doc를 지원합니다. 거기에 맞춰 작성을 하면 IDE에서 바로 보여주니 개발자가 어떤 의도로 변수와 함수를 선언했는 지 명확하고 직관적인 이해가 가능합니다. 그런데 복잡한 로직을 설명하기 위해 주석을 적는 건 비추천입니다. 주석을 봐도 바로 이해하지 못하죠. 그건 아예 로직을 학습하기 편하도록 wiki로 만들어 예시와 함께 작성하고 관리해야 좋습니다.

엡실론 · Answer

클래스와 메서드 선언부면 대부분 충분하죠. 특히 public class, method는 필수로 씁니다. 그 외에 주석이 더 필요하다면 리팩토링을 고려해 보는 게 좋을 수도 있습니다.메서드 내부 변수는 타입과 이름이면 대부분 충분히 이해할 수 있고, 메서드가 그리 크진 않을테니 조금만 읽어봐도 알 수 있습니다. 주석이 필요하다고 느껴진다면, 별도 타입을 만드는게 더 낫진 않은지, 코드를 좀 더 나눌 수는 없을지 고민 해보는 것도 좋습니다.if 분기문도 주석이 필요할 정도면 함수를 추출하는게 더 나을 수도 있습니다.

nippori · Answer

전 말씀하신 그정도가 좋다고 생각합니다. 메소드는 적어주면 좋고, 분기문 정도는 주석을 안 적어도 코드 보면 이해가 되긴 하겠지만.. 이해하기 쉽게 뭐하는 분기다. 라고 딱 한줄만 있어도 그 아래 수십줄 읽고 이해하는 속도가 달라집니다. 다음 작업자들은 정말 도움 많이 될겁니다.

주석 치는 방법? 양? 질문 드립니다.

8개의 답변

기술 목록