코드의 주석은 양날의 검 역할을 합니다. 귀중한 통찰력과 설명을 제공할 수 있지만 오해를 불러일으키거나 혼란을 야기할 가능성도 있습니다. 이 장에서는 코드와 주석 사이의 복잡한 관계를 탐구하고 코드의 명확성과 의도를 모호하게 하기보다는 향상시키는 관행을 옹호합니다.
코드의 진실
소프트웨어 개발의 핵심에는 단순한 진실이 있습니다. 즉, 코드 자체가 소프트웨어가 수행하는 작업의 최종 소스입니다. 주석은 의도가 좋은 경우가 많지만 코드 실행을 변경할 수 없으며 코드가 발전함에 따라 오래되거나 부정확해질 수 있습니다. 코드를 진실의 단일 소스로 인식하면 개발자는 프로그래밍 방식에서 명확성과 정확성을 우선시하게 됩니다.
주석과 잘못된 코드
복잡하거나 불분명한 코드의 단점을 광범위한 주석으로 해결할 수 있다는 것은 일반적인 오해입니다. 그러나 이해하기 위해 주석에 크게 의존하는 코드베이스는 더 깊은 문제의 징후입니다. 설명의 필요성을 최소화하는 표현력 있고 잘 구조화된 코드는 변함없이 선호되며 깔끔한 코딩 관행의 중요성을 강조합니다.
표현적 코드
효과적인 코딩의 핵심은 구조와 명명 규칙을 통해 의도를 직접 전달하는 능력에 있습니다. 코드를 명확하게 작성하면 주석의 필요성이 줄어듭니다. 설명을 자명한 함수나 변수로 변환하면 추가 설명이 필요하지 않아 코드가 간소화되고 가독성과 유지 관리성이 향상되는 경우가 많습니다.
좋은주석의 가치
목표는 주석에 대한 의존도를 최소화하는 것이지만 다음과 같은 특정 유형의 댓글은 매우 중요합니다.
- 법적 및 저작권 참고 사항: 지적 재산권을 보호하고 사용 권한을 명확히 하는 데 필수적입니다.
- 정보 주석: 특히 코드 제약 조건이 있는 경우 컨텍스트를 제공하거나 특정 결정의 근거를 설명합니다.
- 의도 및 설명: 코드가 존재하는 이유를 설명하거나 복잡한 논리를 명확히 하는 설명은 특히 외부 라이브러리나 피할 수 없는 복잡성을 처리할 때 도움이 될 수 있습니다.
안좋은 주석의 함정
반대로, 많은 주석은 코드의 품질과 가독성을 떨어뜨립니다. 예는 다음과 같습니다:
- 중복되거나 오해의 소지가 있는 주석: 명백한 내용을 다시 설명하거나 부정확한 내용을 포함하는 댓글은 도움이 되기보다는 해로울 수 있습니다.
- 오래되었거나 오래된 정보: 설명하는 코드와 함께 유지 관리되지 않은 주석은 혼란을 야기합니다.
- 주석 처리된 코드: 코드베이스를 복잡하게 만드는 일반적인 나쁜 습관으로, 버전 제어 시스템에 대한 신뢰도가 부족함을 나타냅니다.
결론
코드의 주석은 미묘한 공간을 차지하므로 의도를 명확히 하고 이해를 혼란스럽게 할 수 있습니다. 지침 원칙은 코드만으로는 충분하지 않은 곳에 가치를 추가하기 위해 주석을 아껴서 신중하게 사용하여 가능한 한 설명이 필요 없는 코드를 작성하는 것입니다. 코드의 명확성과 표현력을 우선시하는 방식을 채택함으로써 개발자는 주석에 대한 의존도를 줄여 더 깔끔하고 유지 관리하기 쉬운 코드베이스를 만들 수 있습니다.
다음장으로 5장