[개발철학] Simple more Simple

단순명료(單純明瞭)함.

  나의 개발철학은 이 한마디로 정리할 수 있을 듯 하다. 다른 이들이 보아도 나의 개발철학은 단순명료함을 유지하여 적은 시간을 투자하여 빠른 이해와 높은 활용성을 얻도록 하는 것을 목적으로 하고 있다. 나와 동문수학한 다른 이들을 도와주기 위해 그들이 작성한 코드를 가만히 들여보고 있자면, 한숨이 절로 나오는 경우가 있다. 자신이 지정한 변수가 어떤 타입인지 모르고 전혀 엉뚱한 타입으로 받아서 생기는 오류(이클립스와 같은 IDE 툴을 사용하는데도 종종 볼 수 있었다)에서 시작해서 자신이 생각해낸 알고리즘이 아니라, 단순히 인터넷 검색을 통해 나와있는 코드를 그대로 복사해서 붙이면서 발생한 이해불능의 기능으로 인해서 읽기 어려움에 빠진다. 그것을 보면서 나는 저렇게 해서는 안되겠다는 생각을 다짐하고 또 다짐했다. 그와 동시에 이런 나의 생각을 내 개발습관 속에 서서히 녹아들도록 만들었다. 철저하게 코딩스타일을 유지하며 낯설은 부분에서는 이해하기 쉽도록 주석을 첨가하고, 가급적이면 한줄에 하나의 명령어만을 구현하도록 노력했다. 코드는 자기가 봤을 때도 이해하기 쉽고 다른 사람이 봤을 때도 이해하기 쉽게 만들어져야 한다.

   C언어를 배우는 초기에는 컴퓨터의 제약조건들 때문에 한줄에도 많은 명령어를 구현하려고 노력했었다. 하지만, 지금에 와서 PC의 성농은 비약적으로 증가되었으며, 객체지향언어가 발달하고 널리 사용되면서 굳이 적은 코드파일 크기를 고집할 필요성이 약해지고 있다. 이런 상황에서 나는 코드의 가독성과 이해력을 높이기 위해서라면, 한 줄로 끝날 계산도 가급적이면 나누고 나누어서 표현을 하려고 노력한다. 그것이 나의 Simple more Simple 개발철학이다. 이런 나의 개발철학은 나의 개발물들을 후에 다른 사람들이 수정할 일이 생겼을 때 수정하여 사용하기 쉽도록 하여 내 코드의 재활용성을 높여줄 것이다.

  간혹 프리랜서로 일한 사람들의 코드를 보면 쉽게 이해할 수 없는 부분들이 많은 경우가 있다. 이에 대한 문서화도 제대로 되지 않아서 급하게 수정해야할 경우 난해한 경우가 생긴다. 프리랜서로서 그렇게 해야 다시 자신들을 불러줄 거라고 생각하는지 모르겠지만, 개인적으로 그런 습관을 가지고 있는 프리랜서라면 나는 다시는 안 쓴다.  깔끔하고 이해하기 쉬운 코딩스타일을 가지고 있으면서 문서화를 잘하는 프로그래머와 계속 함께 일하고 싶어할 거니까. 나 역시 그런 프로그래머가 되려고 노력할 것이다.

이 글은 스프링노트에서 작성되었습니다.

코딩 스타일이란 무엇인가

작성자 : 김지헌

그리고 코딩하는 단계에서 다음과 같은 작업에 대한 프로그래머마다의 고유한 방식을 코딩 스타일(Coding Style)이라고 한다. 코딩 스타일과 유사한 개념으로 ‘코딩 컨벤션(coding convention)’이라는 것이 있다. 번역하면 ‘코딩 습관’이라는 말이다. 코딩 스타일과 코딩 컨벤션은 거의 동일한 의미다.

1. 논리를 표현하는 방식

2. 알고리즘을 표현하는 방식

3. 문장(statement)를 배치하는 방식

4. 표현식(expression)을 표현하는 방식

한마디로 표현하면, ‘원시 코드를 작성하는 방식 = 코딩 스타일’ 이라고 할 수 있다. ^^

코딩 스타일은 프로그래밍에 있어서 수학이나 영어보다 중요하다.

프로그래머들조차 프로그래머에 대한 잘못된 편견을 가지고 있다. 그 중에서 가장 흔한 것으로는, 프로그래머가 되려면 수학을 잘해야 한다는 편견이다. 물론 수학과 영어를 잘 하면 프로그램을 작성하는 데 도움이 된다. 수학을 잘하면 프로그램의 알고리즘을 잘 세울 수 있을지는 모르지만, 모든 프로그램에 고난이도의 알고리즘이 필요한 것은 아니므로 수학을 잘 한다는 것이 곧 좋은 프로그램을 작성하는 것을 보장하는 것은 아니다. 오히려 대부분의 프로그램 논리는 단순하며, 이미 잘 알려진 알고리즘을 함수의 형태로 제공받아 사용한다.
프로그래머들은 영어로 대화하는 것이 아니라 프로그램으로 대화한다. 영문법에 맞는 매끄러운 영어를 구사하는 사람들이 인정받듯이, 코딩 스타일 규칙에 따라 프로그램을 작성하는 사람이 인정받을 수 있다. 그런 사람은 다른 프로그래머와의 협업에서도 환영받을 것이다.

● 띄어 쓸 때 좋은 코딩 습관

◉ 한 줄에 한 문장만 써라.

1. System.out.println("첫 번째 수는 1입니다."); System.out.println("두 번째 수는 2입니다."); System.out.println("세 번째 수는 3입니다.");
   

여기서 줄(line)이란 편집기(editor) 상에서 보이는 한 줄을 의미한다. Java의 문장이 한 줄은 아니다. 한 줄에 여러 문장을 넣을 수도 있고, 한 문장을 여러 줄에 걸쳐서 할 수도 있다. 그러므로 줄과 문장을 혼동해서는 안 된다.

1. System.out.println("첫 번째 수는 1입니다.");
   

2. System.out.println("두 번째 수는 2입니다.");
   

3. System.out.println("세 번째 수는 3입니다.");
   

위의 예제를 한 줄에 한 문장씩으로 수정하였다. 어느 쪽이 보기 좋은가?

◉선언문과 실행문을 구분하라.

◉단락을 구분하라.

◉ 제어문들 사이를 구분하라.

제어문은 프로그램의 흐름을 바꾸는 역할을 한다. 가정에 따른 선택(while), 상황에 따른 선택(If ~ Else ~ ), 상황에 따른 반복(for)이 이 제어문에 의해서 이루어진다.

◉ 함수들 사이를 구분하여라.

함수들 사이를 띄우지 않은 경우의 단점

[1]. 함수가 어디서 시작되어 어디서 끝나는지 파악하기 어렵다.

[2]. 프로그램이 몇 개의 함수로 구성되어 있는지 파악하기 어렵다.

[3]. 특정 함수가 어디쯤 위치하고 있는지 파악하기 어렵다.

◉ 연산자의 앞뒤로 빈칸을 두라.

1. 1. document.write("<td>"+j+"*"+i+"="+(j*i)+"</td>");
   

2. // 위와 아래의 내용은 같다.
   

3. 2. document.write( "<td>" + j + " * " + i + " = " + ( j * i ) + "</td>" );
   

4. // 어느 쪽 코드가 읽기가 편한가?
   

◉ 단항 연산자(++, --)를 피연산자와 띄어 쓰지 마라.

1. int p = 9;
   

2. ++ p; // p는 몇일까?
   

f = a + ++ b - c - -- d + e; // 이 코드는 이해가 어렵다.

-> f = a + ++b - c - --d + e; // 조금 이해가 쉽다.

--> f = a + ( ++b ) - c - ( --d ) + e; // 괄호를 해주면 이해가 더 쉽다.

● 들여 쓸 때 좋은 코딩 습관

◉중괄호의 위치( {, } )

보는 것처럼 중괄호는 메서드의 끝에서 열고, 닫는 괄호는 메서드의 시작 위치와 같은 선상에 위치하도록 한다.

◉중괄호의 위치를 통일시켜라.

◉내부 블록은 들여 써라.

블록이란 중괄호( {, } )로 둘러싸인 문장을 말한다. 일반적으로 여러 개의 문장을 다른 문장과 구분할 필요가 있을 때 블록을 만든다.

◉피제어부는 들여써라.

= 피제어부를 들여 쓰지 않고 제어부를 완결된 문장으로 바꾼 코드(오류 발생

if ( num1 == num2 );

Systrem.out.println( "num1과 num2가 같다.“ );

들여쓰기를 점검해야 하는 시점

[1]. 프로그램을 완결하기 전
[2]. 프로그램을 다른 사람에게 배포하기 전

[3]. 파일 변환을 마친 후

◉쓸데없는 들여쓰기를 하지 마라.

중요한 것은 들여쓰기를 하는 정도를 일정하게 하는 것이다. 들여쓰기가 꼭 필요하지만 매번 들여쓸 때마다 두 칸이면 두 칸, 네 칸이면 네 칸으로 들여 쓸 공간을 동일하게 적용시켜야 혼란스럽지 않다.

● 식별자 이름을 지을 때 좋은 코딩 습관

◉변수 이름을 체계적으로 지어라.

너무 많은 변수는 우리를 혼란스럽게 만든다. 심지어 프로그램 작성자마저도 어지럽게 한다.

변수 이름을 짓는 방법을 통일하여 그나마 많은 변수들의 바다에 빠져 헤매지 않도록 변수의 물길을 일정하게 해두는 것이 좋다. 변수 이름을 체계적으로 정리하면 혼돈을 피할 수 있다.

◉클래스의 역할을 접두사로 활용하라.

◉이름을 의미 있게 지어라.

변수 이름을 보면 누구나 그 변수에 들어가는 자료가 무엇인지 알 수 있게 하라.

int iThisYear; 이라고 하면, ThisYear가 정수값임을 알 수 있을 것이다.

◉비슷한 변수 이름을 사용하지 마라.

1. int number;
   

2. long int numbers;
   

3. int number;
   

4. short int num;
   

만약 어쩔 수 없이 비슷한 이름을 사용해야 한다면, 이름의 앞이나 뒤에 접두사 또는 접미사를 붙여서 이름을 짓도록 하자. 예를 들어, 다음과 같이 변수 이름 뒤에 숫자를 붙여서 구분하는 것은 흔한 방법이다.

1. int number_01;
   

2. int number_02;
   

◉의미를 잃지 않는 범위에서 짧게 지어라.

이름을 의미 있게 만들기 위해서 무작정 긴 이름으로 지으면 안된다. 예를 들면, 단지 두 개의 정수만이 필요한 프로그램에서 두 정수를 담을 변수의 이름을 다음과 같이 장황하게 지어서 선언할 필요가 없다.

1. int first_integer_number;
   

2. int ssecond_integer_number;
   

3. -> int num1;
   

4. int num2;
   

함수나 클래스의 이름도 마찬가지.

1. New_plus_operation_function();
   

2. New_minus_operation_function();
   

3. -> NewPlusFunc();
   

4. NewMinusFunc();
   

줄여서 쓸 만한 단어는 다른 사람이 이해할 수 있는 범위 안에서 무조건 줄여서 쓴다는 원칙만 잘 기억하면 된다.

◉이름이 길면 밑줄 또는 대소문자로 구분하라.

1. Break_Control_System_Panel();
   

2. BreakControlSystemPaner();
   

예전에는 첫 번째 방법이 많이 쓰였지만, 근래에는 두 번째 방법을 더 많이 사용한다.

◉변수 이름을 밑줄로 시작하지 마라(시작할 수 있다고 해서 사용하지 마라). 중요.

◉밑줄을 과도하게 사용하지 마라. 가급적이면 한번 이상 사용하지 마라.

1. [1]. char File__name___new__name;
   

2. [2]. char File___name__new__name; // 차이를 알겠는가?
   

◉대소문자를 적절히 배합해서 만들어라. 클래스에서는 첫글자는 항상 대문자로 시작하라.

1. Breakcontrolsystempanel();
   

2. BreakControlSystemPanel(); // 어느 것이 구분이 가능한가?
   

◉Java 가 대소문자를 구분한다는 것을 악용하지 마라.

1. int num; // 첫 번째 입력 변수
   

2. int Num; // 두 번째 입력 변수
   

3. int NUM; // 세 번째 입력 변수
   

◉연산자의 우선 순위에 의존하는 식을 만들지 마라.

1. a = 2 + 3 * 4; // 의 값은 얼마인가?
   

2. a = ( 2 +3 ) * 4 // 의 값은 얼마인가?
   

◉시프트 연산 대신 산술 연산을 사용하라.

시프트 연산(shift operation, 자리 옮김 연산)에 쓰이는 << 나 >>는 빠른 배수 계산에 TM이기도 하고 비트를 오른쪽으로 한 개씩 옮기거나 왼쪽으로 자리를 옮기는 경우 크기가 1/2로 줄거나 2배로 증가되기 때문이다.

◎극단적인 효율이 필요하지 않다면 항상 프로그램을 알기 쉽고, 이해하기 쉽게 작성해야 한다. 따라서 시프트 연산으로 수치를 조작하려는 생각은 버리자.

◉극단적으로 효율성을 추구하지 마라.

1. num4 = ( num1 + num2 ) * num3;
   

다음 두 문장으로 기술된 것보다 처리 속도도 빠르고, 기억 장소도 덜 차지한다.

1. temp = num1 + num2;
   

2. num 4 = temp * num3;
   

극단적인 효율을 추구하는 사람은 어떻게든 처리 속도를 빠르게 하기 위해서 매우 복잡한 식을 즐겨 쓰곤 한다. 이렇게 코드를 작성하면 효율성을 얻을 수 있을지도 모르지만, 유지보수 비용이 만만치 않을 것이다. 효율성이 중요하기는 하지만, 간단하고 명료한 코드를 희생할 만큼 중요한 것은 아니다.

우리가 중점적으로 생각할 것은, 간단하고 명료해서 읽으면 이해할 수 있는 코드이다.

◉while 문에서 관계/대입 연산자의 우선순위를 혼동하지 마라.

프로그래머가 생각하는 우선순위를 맞출 수 있도록 괄호를 사용해야 한다. 하지만 프로그래머가 늘 연산자의 우선순위를 기억하고 그것을 고려하여 괄호를 넣을 수는 없다. 그렇기 때문에 while, for, if와 같은 조건식 안에서 조건 연산 외에 대입 연산 등의 다른 연산을 하지 않는 것이 좋다.

◉조건식에 대입문을 사용하지 마라.

조건식(If, for, while)은 제어문에서 아주 중요한 역할을 한다. 조건식의 결과값에 따라서 참과 거짓이 판별되기 때문이다. 프로그래머들은 조건식에 의도적으로나 또는 실수로 대입문을 사용하는 경우가 있다.

가장 흔한 실수로는 조건 식에서 등호( A == B : A와 B가 같다) 대신에 실수로 대입 연산자( A = B : B를 A에 대입한다)를 쓰는 경우다.

1. if ( value == 0) {
   

2. System.out.println("값이 0입니다.");
   

3. }
   

실수로 다음과 같이 등호 대신 대입 연산자를 썼다면 어떻게 될까.

1. if ( value = 0 ) { // 이 경우 value 의 데이터는 0으로 변경된다.

2. System.out.println("값이 0입니다.");
   

3. }
   

-> 조건식에 대입문을 의도적으로 사용한 코드

1. while ( ( value = new_value++ / 20 ) < 10 ) {
   

2. System.out.println( "value의 값은 " + value + "입니다." );
   

3. }
   

위의 예제와 같이 조건식에 대입문을 쓸 경우에는 프로그램을 이해하기가 힘들어진다. 이런 경우에는 알기 쉬운 코드로 만들어 줘야 한다.

1. while ( ture ) {
   

2. value = new_value / 20;
   

3. new_value++;
   

4. if ( value >= 0 ) {
   

5. break;
   

6. }
   

7. System.out.println"value의 값은 " + value + "입니다." );
   

◉부작용이 나타나지 않도록 주의하라.

1. number = 10;
   

2. result = ++number;
   

결과값은 얼마일까? 정답은 11이다. 그러나 정답을 10이라고 말하지 않으려면 단항 연산자의 전치(prefix)와 후치(postfix)에 대해서 이해하고 있어야 한다.

1. number = 10;
   

2. result = number++; // 결과값은 얼마일까? 10이다.
   

3. -> 개선
   

4. number = 10;
   

5. number++;
   

6. result = number;
   

단 한줄의 문장이 늘어났을 뿐인데 앞의 코드와 같이 전치와 후치에 대해서 알아야 하거나 고민할 필요가 없다. 이런 간단한 연산에서 우리는 전치와 후치라는 부작용을 볼 수 있다. 즉, 이 연산에서 'number에 1을 더한다‘는 것은 주된 효과지만, ’++ 연산이 먼저냐, 아니면 = 연산이 먼저냐‘를 결정하는 것은 부작용인 것이다. 단항 연산자의 부작용은 식이 복잡해질수록 더 극명하게 나타난다.

부작용이 꼭 단항 연산자에만 국한되는 것은 아니다. 대입문을 포함한 거의 모든 연산식에서도 우리는 부작용을 가져올 수 있는 문장을 흔히 볼 수 있다.

1. average = total / ( count = last_number - first_number );
   

이처럼 연산식 가운데에 대입문을 두게 되면, 이 대입문이 언제 어떻게 어떤 방식으로 작동하는지에 대해서 고려해야만 문장을 해독할 수 있다. 그러므로 이 문장은 간단한 형태로 바뀌어야 한다.

1. count = last_number - first_number;
   

2. average = total / count
   

부작용을 피하려면 프로그램을 쉽고 짧게 작성해야 한다.

◉함수의 원형에도 인수의 자료형을 표기하라.

◉정밀한 계산이 필요하다면 부동 소수점 연산을 피하라.

부동 소수점은 특성상 정확한 연산을 할 수 없다. 다시 말하면, 늘 오차를 포함하고 있는 것이다. 예를 들어 보자. 1/3을 소수로 표현하면 0.33333333... 처럼 무한소수가 된다. 그러나 컴퓨터는 무한 소수를 표현할 수 없다.

부동 소수점 연산은 늘 오차를 포함하기 때문에,정밀한 계산을 필요로 하는 상황이라면 부동 소수점 보다는 정수를 사용해 연산을 하는 것이 좋다. 특히 금융 관련 계산을 하는 상황이라면 더욱 그렇다.

◉정밀한 계산에는 float 형보다 double 형을 사용하라.

double은 float 형에 비해 두 배 더 큰 자료형이다. 그 만큼 정밀도가 높다. 그렇기 때문에 소수 이하 자릿수를 더 늘려서 계산할 수 있는 것이다. 정밀도를 고려해서 double 형을 사용하라.

◉계산 단위를 반드시 명시하라.

◉나눗셈 연산에는 주의를 기울여라.

1. int num;
   

2. num = 15 / 10; // num의 값은 얼마일까?
   

답은 1이다. 왜냐하면 15을 10으로 나누면 1.5가 되는데, 이 계산식에서 15 / 10은 정수형 자료 간의 연산이다. 이런 정수형 자료 사이의 연산에서는 소수인 0.5가 제거되고 1만이 최종 결과가 된다. 이처럼, Java 언어에서는 정수형 데이터의 나눗셈에서 가차없이 소수 이하 부분을 잘라버린다.

1. float result;
   

2. result = 1 / 3; // 의 결과값은 얼마일까?
   

0.33333...일 것이라 예측하겠지만, 결과는 0.0 이 나온다. 여기에 나눗셈의 함정이 숨어 있다.

result = 1 / 3; 이라는 문장에서 1/3이 먼저 정수형으로 계산되고 나서 result에 대입된다.

◉자료형의 변환이 이루어지지 않도록 하라.

강제변환 (int)(3.14f)와 같은 것도 사용을 자제하라.

◉goto 문을 사용하지 마라.

짜파게티 소스를 만들고 싶지 않다면, goto 문을 쓰지 마라. 나중에 후회한다.

◉조건식(조건 연산자) 보다는 if문을 사용하라.

1. if ( num1 == num2 ) {
   

2. temp = num 3 + f( num1 );
   

3.  

4. } else {
   

5. temp = f(num1) - num3;
   

6. }
   

이 문장을 한줄짜리 조건식으로도 바꿀 수 있음.

1. temp = ( num1 == num2 ) ? d + f ( num1 ) : f( num1 ) - d;
   

어느 편이 읽기 쉽고 이해하기 쉬운가? 그리고 어느 편이 더 효율적인가? 일단 효율적인 면에서 보면 한 줄 짜리 조건식이 조금 더 효율적이다. 그러나 컴퓨터 성능이 좋아진 지금에서는 큰 차이가 없다. 읽기 쉬움, 즉 가독성의 측면에서 보면 if 문이 좋다. 훈련된 프로그래머들은 조건식이 더 해석하기 쉽다고 말할지도 모르지만, 그건 소수의 훈련된 프로그래머의 얘기일 따름이다.

◉배열의 차원을 3차원으로 한정하라.

1. multi_dimention[10][20][30][40]....[10];
   

배열은 얼마든지 선언해서 사용할 수 있다. 그러나 이런 배열은 무용지물이다. 우리의 사고력의 한계가 있기 때문이다.

● 오류없는 프로그램을 만들기 위한 좋은 코딩 습관

◉배열의 index는 0부터 시작한다는 것을 잊지마라!! 잊으면 곤란해!!

◉치환 문자열은 반드시 괄호를 씌워라.

◉괄호를 열었다면 반드시 닫아라.

이런 경우를 방지하기 위하여, 괄호를 생성시 {} () 열린 괄호와 닫힌 괄호를 바로 입력하고 그 사이에서 확장해 나가는 방식을 사용하도록 하라.

이 글은 스프링노트에서 작성되었습니다.