개발할 때 주석 잘 사용하시나요?

공부/자기계발

개발할 때 주석 잘 사용하시나요?

셩잇님 2023. 3. 11. 17:41

주석 사용에 있어 두 가지 의견이 있는 것 같은데요..! 다른 개발자 분들은 주석을 어느정도로 사용하는지 궁금해서 질문 남깁니다.

1) 주석을 최대한 줄이고 네이밍이나 로직등 코드만 보고 알 수 있게 작성해야 한다.
2) 복잡한 로직은 다른 사람이 이해하기 쉽게 주석을 남긴다.

주석에 대해 어떤 의견을 갖고 계신가요?

1, 2번 중에 뭐가 더 좋다라고 명쾌하게 말을 할 수는 없겠지만, ‘최대한 코드만 보고도 이해할 수 있게 코드를 짜는 것을 지향하면 좋다.’ 라고 말씀드리고 싶습니다. 이렇게 코드를 짜려는 연습을 하려면 코드를 짜기 전에도 설계도와 같은 그림을 그리게 되고, 그러면 최소한의 방향성이 생깁니다. 100% 그 방향대로 가지 못하더라도 탈선은 하지 않을 수 있다는 점에서 코드만 보고도 이해할 수 있게 짜보려는 연습은 필요하다고 생각듭니다!
사실 내 코드만 보고 이해하는 사람의 범위는 최대 팀 한정이라고 생각합니다. 모든 개발자가 이해할 수 있는 코드란 존재하지 않는다고 생각해요. 팀 마다 규칙과 중요하게 생각하는 가치가 다를 수 있잖아요?? 그치만 모든 개발자들이 중요하게 생각하는 가치도 분명 존재한다고 생각하는데, 그 가치만은 최소한 지켜서 코드를 짜려는 노력이 우리겐 필요하지 않을까요!!😃

안녕하세요. 말씀해주신 1,2번 모두 사용하고 있습니다.
변수나 간단한 함수는 네이밍으로 명확하게 어떤 것을 의미하는지 하는게 기본이고요,
데이터 구조가 복잡하거나, 함수 내에서 처리하는 로직이 복잡하거나 했을 때 주석을 남겨놓습니다. 주석을 남기는 이유는 다른 사람과 같이 일하기 때문에 이해에 도움을 주기 위한 것이고, 나중에 유지보수할 때 (1~2년후가 될수도 있음) 코드를 빠르게 이해할 수 있는 목적이 크다고 보시면 될 것 같습니다. 주석을 달 때는 그런 점을 고려해서, 잘 정리해서 달아두는게 좋다고 생각합니다.

1, 2번 모두 지향하는 편입니다.
저희 회사 내부적으로는
1번은 보통 데이터레이어 단에서 명확하게 하려고 노력하는 편이고,
2번은 비즈니스 레이어에서 3개 이상의 데이터 레이어에 관여할때 주석을 적는 편입니다.

정답은 말씀주신대로 따로 있지는 않아서 각 상황에 맞게 선택하면 될 것 같아요