Regular Motion

개발자가 상팔자

1. Programming Style.

1) 전역변수에는 서술적인 이름을, 지역변수에는 짧은 이름을 붙여라.
    전역변수는 프로그램의 어디에서나 사용할 수 있는 것이기 때문에, 코드를
    보는 사람들이 그 의미를 떠올릴 수 있을 정도로 길고 서술적이어야 한다.
    또한 전역변수를 선언할 때 간단한 주석을 달아주는 것도 좋다.
  
    하지만 지역변수에는 짧은 이름을 써도 충분하고, 만약 루프변수나 통상적으로
    사용되는 지역변수들에게 이름을 길게 붙여 주는 것은 낭비다.

    for (theElementIndex = 0; theElementIndex < numberOfElements; theElementIndex++)

       elementArray[theElementIndex] = theElementIndex;
                         ↓
    for (i = 0; i < nElems; i++)
      elem[i] = i;
 
    코드의 명료성은 간결함을 통해 얻을 수 있는 경우가 많다.

2) 함수 이름에는 능동형 동사를 써라.
    함수이름은 getTime()과 같이 능동형 동사 + 명사를 쓰는 것이 좋다.
    만약 불리언을 반환하는 함수일 경우, 반환 값이 모호하지 않도록,
    isOctal()과 같이 이름을 붙여주는 것이 좋다.

3) 소리내어 읽을 수 있는 이름이 좋다.

4) 부정을 포함하는 조건식은 언제나 이해하기 어렵다.
    if (!(block_id < actblks) || !(block_id >= unblocks))
                         ↓
    if ((block_id >= actblks) || (block_id < unblocks))
    대부분의 조건식에서 부정을 제거할 수 있다. 자연스럽게 코드를 읽을 수 있도록
    부정을 제거하도록 하자.

5) 주석이 코드보다 길다면, 코드를 수정하는 것이 옳다.

답글 남기기

© 2017 Regular Motion

Theme by Anders NorenUp ↑