어떻게 코드의 가독성을 높입니까

Brain W. Kernighan & Rob Pike가 공동 저술한 The practice of programming을 보고 있다.책에서 많은 실용적인 세부 사항을 언급했는데 대부분이 작가의 다년간의 프로그래밍 경험에서 비롯된 것이다. 코드 스타일에 관한 부분은 개편이고 많은 편폭이 있다. 여기서 개인이 중요하게 생각하는 원칙(rules)을 요약하고 발췌한다. 비록 작지만 매우 중요하기 때문에 필요한 것은 관련 코드를 첨부한다.
1. 이름(Name)
1. 전역 변수에 대해서는 좀 더 묘사적인 이름을 사용하고 국부 변수에 대해서는 짧은 이름을 사용한다.(Use descriptive names for globals, short name for locals)
2. 표현식 및 문(Expressions and Statements)
1. 필요한 괄호로 잘못된 의미 제거하기(Parenthesize to solve ambiguity)
많은 조작부호들이 각자의 우선순위가 있기 때문에, 좋은 괄호를 사용하지 않거나 완전히 잊어버리면 프로그램이 논리적인 문제를 일으켜 실행할 수 없다.
다음은 샘플 코드입니다.if (x&MASK == BITS)
괄호가 없으면 코드는if (x & (MASK == BITS))
그런데 실제로 조작하고 싶은 건...if ((x&MASK) == BITS)
2. 복잡한 표현식을 분리하여 쓰기(Break up complex expressions)*x += (*xp=(2*k < (n-m) ? c[k+1] : d[k--]));
위의 이 코드는 가독성이 매우 떨어지지만, 우리가if else 문장으로 뜯으면 훨씬 좋아질 것이다.

if (2*k < n-m)
*xp=c[k+1];
else
*xp =d[k--];
*x += *xp;

책에는 "우리의 목표는 똑똑한 코드로 자인하는 것이 아니라 뚜렷한 코드를 쓰는 것이다."라고 적혀 있다.
다음을 수행합니다.연산자 사용에 대한 권장 사항은 다음과 같은 짧은 표현식에만 적용됩니다.max = (a > b) ? a : b ;
코드는 짧을수록 좋은 것이 아니다. 논리가 명확하고 읽을 수 있는 것이 매우 중요하다. 만약에 읽을 수 있는 대가를 줄여서 코드를 줄이는 것은 권장하지 않는다.최적화 알고리즘을 생각해 보는 게 좋을 것 같아요. P.
3. 부작용(Be careful with side effects)str[i++] = str[i++] = ' ' ; 이 코드는 빈칸을str의 뒷 두 위치에 저장하는 것을 의미하지만, 이것은 i가 데이터를 업데이트하는 시간에 달려 있기 때문에 i가 1만 증가했을 수도 있다.이런 상황을 피하기 위해서 우리는 반드시 그것을 뜯어야 한다

str[i++] = ' ' ;
str[i++] = ' ' ;

한 변수만 증가해도 비슷한 경우a[i++] = i ;가 있을 수 있다. 만약 초기값이 3이라면 결과는 3 또는 4일 수 있다.
3. 지속성과 습관(Consistency and Idioms)
1. 괄호 사용 스타일에 지속성 유지
여기서 또 자주 논쟁되는 문제는'꽃괄호는 도대체 문장 뒤에 직접 놓아야 하는가, 아니면 줄을 바꾸어 써야 하는가'이다.이 작성자의 권장 사항은 다음과 같습니다.
네가 좋아하는 것을 골라서 유지해라. 말다툼에 시간을 쓰지 말고.(Pick one style, use it consistently,and don't waste time arguing.):D
한 가지 언급할 만한 세부 사항은 다른 사람이 쓴 코드를 수정할 때 그의 코드 스타일에 따라 써야 한다는 것이다. 왜냐하면 스타일의 통일을 유지하고 나중에 코드를 수정하는 사람을 편리하게 하기 때문이다.
2, 무한 순환 의 선택
무한한 순환에 대해 저자는 다음과 같은 두 가지 표현만 건의한다for (; ;)while( 1 )
3. gets 조심
원어는'one shoud never use gets'이다.gets로 읽을 입력 길이를 제한할 수 없기 때문에 이러한 결함은 안전 문제를 초래할 수 있고 fgets는 더욱 좋은 선택이 될 것이다.
4. 여러 가지 상황에 대해 else-if 문장을 사용하고if를 최대한 적게 삽입한다
다음 두 가지 코드 스타일을 비교하다
if 중첩:

if (argc==3)
if((fin = fopen(argv[1], "r"))!= NULL)
if((fout = fopen(argv[2],"W"))!= NULL){
while( 
...........
)
}else
printf(" .........."); `
else
.............
else
..............

else-if 문:

if (argc != 3)
printf(" Usage: cp inputfile outputfile
");
else if (...........)
else if(............){
......
....
}else{
.....
}

좋은 코드를 쓰는 습관은 코드를 쓰는 가독성을 높일 수 있고 디버깅의 효율을 높일 수 있으며 자신과 나중에 프로그램을 수정하는 다른 프로그래머에 대한 존중이기도 하다. D