본문으로 이동
메뉴 여닫기
환경 설정 메뉴 여닫기
개인 메뉴 여닫기
로그인하지 않음
지금 편집한다면 당신의 IP 주소가 공개될 수 있습니다.

프로그래밍 스타일(Programming Style)은 프로그램이 올바르게 동작하는 것을 넘어 다른 사람이 읽고 고치기 쉽도록 코드를 쓰는 방식과 그 지침으로, 명료성·단순성·일관성을 앞세우고 코드와 문서를 서로 맞게 유지하는 것을 핵심으로 한다.

프로그램은 한 번 쓰이고 여러 번 읽힌다. 유지보수에 드는 비용이 개발 비용보다 큰 경우가 많으므로, 코드를 쓰는 사람은 컴퓨터보다 다음에 읽을 사람을 생각해야 한다. 커니핸(Brian W. Kernighan)과 플라우거(P. J. Plauger)는 1974년 『The Elements of Programming Style』에서 실제로 출판된 프로그램의 나쁜 코드를 고쳐 쓰며 이런 지침을 짧은 격언으로 정리했고, 그 뒤 클린 코드, 리팩토링, 코드 스타일 같은 흐름이 이를 이어받았다.[1][2]

지침 뜻
명료하게 써라 영리한 기교보다 뜻이 바로 드러나는 코드가 낫다. 하고 싶은 일을 단순하고 직접적으로 쓴다
빠르게 만들기 전에 명료하게, 올바르게 만들어라 효율을 위해 명료성을 희생하지 않는다. 먼저 명료하고 올바른 프로그램을 만든 뒤 필요한 곳만 측정해 빠르게 한다. 빠르게 고칠 때도 올바름을 지킨다
임시 변수를 지나치게 쓰지 마라 한 번 쓰고 버리는 중간 변수가 많으면 값의 흐름을 따라가기 어렵다. 식이나 함수 호출로 바로 쓰는 편이 읽기 쉽다(리팩토링의 '임시 변수를 질의 함수로 바꾸기'도 같은 생각이다)
중복은 함수로 되풀이되는 식은 공통 함수로 바꾸고, 표준 라이브러리 함수를 쓴다
이름과 괄호 헷갈리지 않는 변수 이름을 고르고, 우선순위가 모호한 식은 괄호로 묶는다
제어 흐름을 단순하게 불필요한 분기와 goto 를 피하고, 이해하기 어려운 논리식은 바꿔 쓴다
입력을 검사하라 입력의 타당성과 프로그램의 한계를 확인하고, 잘못된 입력을 찾아 가능하면 복구한다
나쁜 코드는 고쳐 써라 나쁜 코드에 주석을 달거나 땜질하지 말고 다시 쓴다
주석과 코드가 일치하게 하라 코드를 고치면 주석도 고친다. 코드를 그대로 되풀이하는 주석은 쓰지 않는다 → 주석 (프로그래밍)

오류가 날 수 있는 곳마다 반환값을 검사하는 코드가 흩어지면 정상 흐름이 묻힌다. 현대 언어는 예외 처리(try-catch)를 써서 정상 처리와 오류 처리를 나누어 다양한 오류를 간결한 구조로 다루게 한다. 다만 예외를 삼키거나(빈 catch) 정상적인 분기에 예외를 쓰면 오히려 흐름이 흐려지므로, 처리할 수 있는 곳에서 구체적인 예외를 잡는다.

코드와 설계 문서의 일치

편집 원본 편집

코딩 단계에서 설계가 바뀌면 그 변경을 설계 문서에도 반영해야 한다. 코드만 고치고 설계서를 두면 문서와 실제 프로그램이 어긋나, 유지보수하는 사람이 틀린 문서를 믿고 작업하게 되고 요구사항-설계-코드-테스트 사이의 추적성도 끊긴다. 그래서 설계 변경은 형상 관리의 변경 통제 절차를 거쳐 승인받고, 관련 산출물(설계서, 인터페이스 명세, 테스트 케이스)을 함께 고친다 → 소프트웨어 문서화

  • "소스코드 작성 단계에서 생긴 설계 변경은 설계 문서에 반영할 필요가 없다"는 바람직한 코딩 지침이 아니다

지침들이 노리는 품질

편집 원본 편집
  • 가독성 - 처음 보는 사람도 빨리 이해한다
  • 유지보수성 - 고칠 곳을 찾기 쉽고, 고쳐도 다른 곳이 덜 깨진다
  • 신뢰성 - 단순한 코드에는 결함이 숨기 어렵다
  • 효율은 이 셋을 해치지 않는 범위에서, 측정으로 확인된 병목에만 추구한다
  1. ↑ B. W. Kernighan, P. J. Plauger, 『The Elements of Programming Style』 2nd ed., McGraw-Hill, 1978.
  2. ↑ S. McConnell, 『Code Complete』 2nd ed., Microsoft Press, 2004.