유지보수 가능한 코드를 위한 세 가지 태도
Source
Evernote/Inbox/Three Attitudes that Lead to Maintainable Code.md
Summary
이 문서는 DRY, 단일 책임 원칙 등 구체적인 원칙보다는 유지보수성을 높이는 세 가지 넓은 관점(태도)을 제시합니다. 첫째, ‘관점 전환’으로 새 개발자나 미래의 자신을 위해 코드를 읽고 이해하기 쉽게 작성하며, 주석보다는 명명 규칙을 통해 자기 문서화(Self-documenting) 코드를 지향합니다. 둘째, ‘깔끔함의 중요성’으로 기계보다 인간을 위해 코드를 작성하며, 교묘함(Cleverness)보다 명확성(Clarity)과 가독성을 우선시합니다. 셋째, ‘특수 케이스 회피’로 임시방편이나 부분적으로만 작동하는 해결책 대신 근본적인 문제를 해결하여 코드의 일관성을 유지해야 합니다.
Key Points
- 구체적인 원칙(DRY 등)보다 유지보수성을 위한 넓은 관점 유지
- 새 개발자 관점에서 코드의 흐름과 명명 규칙 검토 (자기 문서화 코드)
- 주석 남용 금지: 코드 외부 요인(고객 요구사항 등) 설명에만 주석 사용
- 인간을 위한 코드 작성: 가독성과 명확성이 작은 최적화보다 중요
- 교묘함(Cleverness)보다 단순함과 명확성(Clarity) 선호
- 임시방편(Duct tape)이나 특수 케이스(Special cases) 회피
- 근본 원인 해결을 위한 리팩토링의 필요성 강조