변수명과 함수명으로 대부분을 설명할 수 있으면 가장 좋고 그걸로 설명이 되지 않는 부분은 코멘트로 채우기 바랍니다. CODE COMPLETE, Writing Solid Code 등 네이밍, 코멘트에 관련해서 잘 정리된 서적들 많으니 참고해서 일관성있게 작성하기 바랍니다. 코멘트나 네이밍 시간이 많이 걸려서 싫다는 사람이 가끔 있는데 정말 그건 말도 안되는 겁니다. 코멘트, 네이밍시간이 아무리 걸려봤자 코딩하고 디버깅하는 시간에 비하면 비교자체가 안되지만 제대로 코멘트와 네이밍을 하면서 프로그래밍을 하면 코딩과 디버깅 시간이 급격히 단축됩니다.
2. 헝가리안 표기법을 축약해서라도 변수에 타입을 나타낸다.
헝가리안 표기법을 싫어하는 사람들이 많은데 헝가리안 표기법을 축약해서 변수의 크기별, 배열, 스트링 여부만 가려주는 식으로 사용하면 대부분의 변수 앞에 단 한글자만 붙이면 되고 전역, 배열, 포인터 등에 한글자 정도 더 쓰면 됩니다. 변수 타입 정의 10개 이하의 접두사에 전역, 배열만 접두사를 하나 더 붙이면 되는 간단한 방식이죠. 상수, 구조체 정의는 전체 대문자를 사용하는 식이구요. 익히는게 오래 걸리는 것도 아니고 한두글자가 입력을 오래걸리게 하는 것도 아닌데 그 효과는 상당히 좋은데 그게 싫다는 건 제 상식으로는 이해 불가입니다. 복잡하고 접두사가 길어지는 헝가리안 표기법에 대해서는 저 조차 회의 적이지만 접두사를 아예 안붙이는 것과 붙이는 것은 프로그래밍의 효율에 큰 영향을 끼칩니다.
3. 함수마다 가능하면 ASSERT를 넣는다.
입력 범위 값을 벗어나는 값을 검토하는 ASSERT를 넣습니다. 특히 나누는 값 같은 경우는 반드시 ASSERT를 넣습니다. ASSERT에 스택 트레이스를 추가하면 호출한 함수들을 계속 추적해서 보여줄 수 있습니다. 어셈블리의 경우 전체 레지스터의 값들을 출력하면 좋구요. 이런식으로 ASSERT를 강하게 만들면 어떤 에러가 발생해도 에러가 발생한 함수를 호출한 시작 위치까지 추적이 되기 때문에 디버깅이 매우 쉬워집니다. ASSERT는 얼마든지 코드에 포함시킬수도 뺄 수도 있기에 넣는데 주저할 필요가 없고 컴파일러에서 제공하는 ASSERT가 아닌 직접 만들어 스택 트레이스를 이용한 함수 추적이나 레지스터 정보 출력 등 훨씬 상세한 정보를 제공하는 ASSERT를 만들어 사용하면 됩니다.
4. TRACE 또한 포함시키는걸 아끼지 않는다.
TRACE를 사용해서 값을 찍어보면 쉽게 해결될 수 있는 문제도 어렵게 해결하는 경우가 있습니다. 원하는 경로로 실행이 되고 있는지, 값이 정확한지, 제대로 실행이 되는지 검토하는 건 대부분 TRACE로 해결이 가능합니다. 컴파일시 빼버리면 되기에 성능에 지장이 있는 것도 아닌데 구지 사용하지 않을 이유가 없죠.
훌륭한 코멘트에 좋은 네이밍 만으로도 버그가 생길 확률은 압도적으로 줄어듭니다. 거기에 TRACE와 ASSERT를 사용하면 대부분의 버그가 사라지고 마지막으로 ASSERT를 강화해서 스택 트레이스, 레지스터 상태 출력 등을 포함하면 극소수의 버그만 남습니다. 이걸로도 안되면 운영체제가 제공하는 SEH를 사용하거나 디스어셈블리를 하거나 해야겠죠.
글쓰기