프로그래밍 스타일
IT위키
더 많은 작업
프로그래밍 스타일(Programming Style)은 프로그램이 올바르게 동작하는 것을 넘어 다른 사람이 읽고 고치기 쉽도록 코드를 쓰는 방식과 그 지침으로, 명료성·단순성·일관성을 앞세우고 코드와 문서를 서로 맞게 유지하는 것을 핵심으로 한다.
| 지침 | 뜻 |
|---|---|
| 명료하게 써라 | 영리한 기교보다 뜻이 바로 드러나는 코드가 낫다. 하고 싶은 일을 단순하고 직접적으로 쓴다 |
| 빠르게 만들기 전에 명료하게, 올바르게 만들어라 | 효율을 위해 명료성을 희생하지 않는다. 먼저 명료하고 올바른 프로그램을 만든 뒤 필요한 곳만 측정해 빠르게 한다. 빠르게 고칠 때도 올바름을 지킨다 |
| 임시 변수를 지나치게 쓰지 마라 | 한 번 쓰고 버리는 중간 변수가 많으면 값의 흐름을 따라가기 어렵다. 식이나 함수 호출로 바로 쓰는 편이 읽기 쉽다(리팩토링의 '임시 변수를 질의 함수로 바꾸기'도 같은 생각이다) |
| 중복은 함수로 | 되풀이되는 식은 공통 함수로 바꾸고, 표준 라이브러리 함수를 쓴다 |
| 이름과 괄호 | 헷갈리지 않는 변수 이름을 고르고, 우선순위가 모호한 식은 괄호로 묶는다 |
| 제어 흐름을 단순하게 | 불필요한 분기와 goto 를 피하고, 이해하기 어려운 논리식은 바꿔 쓴다 |
| 입력을 검사하라 | 입력의 타당성과 프로그램의 한계를 확인하고, 잘못된 입력을 찾아 가능하면 복구한다 |
| 나쁜 코드는 고쳐 써라 | 나쁜 코드에 주석을 달거나 땜질하지 말고 다시 쓴다 |
| 주석과 코드가 일치하게 하라 | 코드를 고치면 주석도 고친다. 코드를 그대로 되풀이하는 주석은 쓰지 않는다 → 주석 (프로그래밍) |
오류가 날 수 있는 곳마다 반환값을 검사하는 코드가 흩어지면 정상 흐름이 묻힌다. 현대 언어는 예외 처리(try-catch)를 써서 정상 처리와 오류 처리를 나누어 다양한 오류를 간결한 구조로 다루게 한다. 다만 예외를 삼키거나(빈 catch) 정상적인 분기에 예외를 쓰면 오히려 흐름이 흐려지므로, 처리할 수 있는 곳에서 구체적인 예외를 잡는다.
- 가독성 - 처음 보는 사람도 빨리 이해한다
- 유지보수성 - 고칠 곳을 찾기 쉽고, 고쳐도 다른 곳이 덜 깨진다
- 신뢰성 - 단순한 코드에는 결함이 숨기 어렵다
- 효율은 이 셋을 해치지 않는 범위에서, 측정으로 확인된 병목에만 추구한다