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

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

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

메소드 같은 것들은 기능에 대해 간단히 주석을 달면 나중에 검색도 되어서 유용합니다

1, 2번 모두 지향하는 편입니다. 저희 회사 내부적으로는 1번은 보통 데이터레이어 단에서 명확하게 하려고 노력하는 편이고, 2번은 비즈니스 레이어에서 3개 이상의 데이터 레이어에 관여할때 주석을 적는 편입니다. 정답은 말씀주신대로 따로 있지는 않아서 각 상황에 맞게 선택하면 될 것 같아요

1번으로 작성하는걸 목표로 하고 있습니다. 코드가 곧 문서가 되는게 가장 이상적이고 코드만으로 설명되지 않는 부분에 주석을 달아주고 있습니다.

최대한 1번의 코드를 짜려고 하지만 경우에 따라 2번까지 필요한것 같습니다. 어차피 내가 짠 코드는 나만의 것이 아닌 팀의 것이고 나중에 조직개편이나 기타 상황으로 도메인 전체가 타부서 이관되는 것 까지 생각한다면 제삼자가 봤을때 무리없이 이해가 가야 한다고 생각되기 때문입니다.

1번을 지향하는건 당연하지만 어쩔수없이 결국에는 소스가 더러워지더라고요...... 그럼 남들이 보기 어려워지므로 결국 2번으로 갈수밖에 없게 됩니다.

환경과 상황에 따라 케바케이긴 하겠지만, 저는 2번을 선호하는 타입입니다~ 상대방을 위함을 떠나서, 제 스스로도 정리 잘 되어서 좋아요! 그리고 혹시 상대방이 원치 않다면 지우는 것은 신속하게 가능하기에 큰 문제는 없을 것으로 보입니다!

2

뭐든 답은 없는 것 같습니다. 다만 저는 깔끔하거나, 주석 컨벤션이 있다는 가정하에 주석을 선호해는 편입니다. 직관적으로 단어를 쓴다고 해도 카멜, 스네이크, 파스칼 등과 같은 방식으로 표기하다보면 단어자체가 줄여져서 결과적으로 직관적이진 않은 경우가 있더라구요 그렇기 때문에 주석 쪽에 기울여지지만, swagger나 spring rest doc 같은 라이브러리로 표현하는 것을 가장 선호합니다 !

주석을 사용하고 하지않고의 차이는 Private과 Public의 차이라고 생각합니다.