프로그래밍 스타일에 대한 고찰

 코딩을 통해서 배우는 초보단계인 나의 입장에서는 3000~4000줄 정도 되는 프로젝트를

진행할 때 어려웠던 점이 몇 가지 있었다. 이 어려움이라는게 알고리즘, 자료구조적 어려움

이 아니라 정말 기본중에 기본이라 가벼이 넘기게 되었던 변수, 메소드, 클래스에서의 이름 지정에

관한 것이었다. 변수명을 간결하자니 나중에 알아보기 힘들고, 서술적으로 하자니 소스가 길어지고

그래서 어떻게 우야부야 넘기긴 했는데, 마음 한 구석이 편하지는 않았다.

 그 때문에 변수, 메소드, 클래스 명의 표준화라는게 필요하다고 절실히 생각했는데 그에 관한

고찰을 한번 해보고자 한다.

 일단 프로그래밍의 본질을 알아보고, 그를 통해서 어떤 식으로 고찰을 해야할지 생각해보자.

우선 프로그래밍에 있어서 가장 중요한 것은 

 단순성(Simplicity)

 명확성(Clarity)

 일반성(Generality)

 자동화(Automation) 인데, 각각의 의미는 

 단순성(Simplicity)은 프로그램의 간결성과 관리성을 위한 쉬운 코드이고,

 명확성(Clarity)은 기계와 사람이 함께 이해하기 쉬운 것,

 일반성(Generality)은 다양한 상황에서 잘 동작하고, 새로운 상황이 발생해도 잘 되는 것을 말하며,

 자동화(Automation)는 자질구레한 작업은 컴퓨터가 하므로써 인간의 편리성을 증대하는 것을 말한다.

 스타일에 관한 조언

 

 전역변수에는 서술적인 이름을, 지역변수에는 짧은 이름을 붙여라.

 일관성을 지키자.

 함수 이름에는 능동형을 써라.

 정확한 이름을 써라.

 들여쓰기로 구조를 알아보기 쉽게 하라.

 표현식을 자연스럽게 써라.

 괄호를 써서 애매함을 해소하라.

 복잡한 표현은 잘게 쪼개라.

 명료하게 써라.

 부수효과를 조심하라.

 들여쓰기와 중괄호 '{}'를 스는 스타일은 일관성 있게 써라.

 일관성을 위해 관용 표현을 사용하라.

 다중결정이 필요할 때는 else-if를 사용하라.

 매크로 함수를 멀리하라.

 매크로 전체와 각 인자를 괄호로 묶어라.

 매직넘버에 이름을 달아주어라.

 숫자는 매크로로 쓰지 말고 상수로 정의하라.

 아스키 문자는 숫자 코드가 아닌 문자 상수로 사용하라.

 언어에서 제공하는 것을 써서 객체의 크기를 계산하라.

 명확한 코드에는 주석을 달지 말라.

 함수와 전역 데이터에 주석을 달아라.

 나쁜 코드에 대해 설명하지 말고 새로 짜라.

 주석과 코드가 모순되게 하지 말라.

 혼란스럽게 하지 말고, 명확하게 하라.