[ Programming ]

Clean Code

클린 코드
[클린 코드] 4-5장 주석-형식 맞추기
클린 코드 이번 글에서는 좋은 주석 쓰는 방법과, 형식 맞추기 방법 들에 대해서 소개할게요. 4장. 주석 잘 달진 주석은 그 어떤 정보보다 유용해요. 하지만 근거 없는 주석은 코드를 이해하기 어렵게 만들어요. 그리고 오래 관리가 안된 주석은 잘못된 정보를 전달하기도 해요. 저자는 주석은 필요악이라 표현해요. 코드 자체에 표현력과 전달력이 있다면 주석은 거의 필요하지 않기 때문이에요. 즉, 나쁜 코드에 주석을 달은 경우라고 볼 수 있어요. 그래서 주석을 달기전에 먼저 코드로 의도를 표현할 방법이 없을지 생각해보는 것이 좋아요. 주석을 달면 본인이 표현력이 부족함을 인정하는 것과 마찬가지에요. 그러면 왜이렇게 주석을 미워할까요? 바로 주석이 거짓말하는 경우가 많아서에요. 고의적으로 거짓말하는 것은 아니지만, 주석이 오래될수록 코드에서 멀어지기 때문이에요. 또한 개발자가 주석을 유지 및 보수하는 것도 현실적으로 불가능하다고 여겨져요. 아마도 주석을 달아봤으면 알거에요. 언제 썼는지 기억이 안나요. 코드는 변화하고 진화해요. 여기 저기 옮겨다니기도 해요. 그리고 분열했다가 합쳐지기도 합니다. 그래서 주석이 코드를 따라가기 힘들어요. 주석은 나쁜 코드를 보완하지 못한다. 코드에 주석을 추가하는 가장 일반적인 이유는 코드 품질이 나쁘기 때문이에요. 모듈을 짜고 보니 짜임새가 엉망이고 알아먹기가 힘들어 주석을 달아야겠다는 결심을 하죠. 이럴 땐 "주석을 달아야겠다!"가 아니라 "코드를 정리해야겠다!"라고 말할 수 있어야해요. 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 어수선하며 주석이 많이 달린 코드보다...
2025-11-11
0
0
10
클린 코드
[클린 코드] 1-3장 깨끗한 코드 ~ 함수
클린 코드 1장. 깨끗한 코드 좋은 코드(Clean Code, 깨끗한 코드)는 왜 필요한 이유는 나쁜 코드로 치르는 대가가 점점 커지기 때문이에요. 이제 프로젝트 진행을 하는데 있어 시간이 지남에 따라 클린 코드가 왜 필요한지 알아봐요. 클린 코드의변경 비용 그래프 프로젝트 규모가 커짐에 따라 결국 더러운 코드의 생산 비용이 더 커지게 되요. 그러면 항상 클린 코드로 코드 관리를 하는 것이 좋을까요? 간단한 토이 프로젝트 같은 경우에는 분기점의 왼쪽의 규모에 해당한다면 그냥 대충 코드를 짜는게 오히려 생산성이 더 좋다고 볼 수 있어요. 프로젝트 관리자는 이러한 경험들을 바탕으로 어느 정도로 클린하게 코드를 짤 지, 그 분기점이 어느 정도 규모일지를 생각해서 코드 관리를 하는 것이 좋다고 생각해요. 클린 코드의 생산성 변화 위 그래프는 코드 관리에 따른 생산성 변화 그래프를 나타내요. 코드가 엄청 더러운데 계속 추가하면, 기존 담당자 뿐 아니라 새로 들어온 사람도 코드 파악도 힘들고 고치기도 힘들꺼에요. 그러면 코드베이스 파악이 힘들고, 새로운 사람의 투입 시간도 오래 걸릴거에요. 나쁜 코드로 치르는 대가 나쁜 코드가 증가하면 생산성 저하로 이어져요. 그러면 프로젝트 관리자는 생산성을 위해 인력을 추가할 거에요. 그러면 추가된 인력은 기존 코드베이스를 파악하기 어렵고 설계 의도를 적절히 반영하기도 힘들어져요. 결국 이는 나쁜 코드가 또 증가하게 되고 악순환이 반복되요. 그래서 우리는 생산성 저하를 해결하기 위해 인력 추가만을 생각할 것이 아니라 코드 관리도 생각해야해요. 코드 감각 이제까지 클린 코드가 왜 중요...
2025-10-27
0
0
17