C 코딩 스타일 가이드 - 함수

본 문서는 소프트웨어 개발 시 준수해야 하는 코딩 스타일을 정의하고 가이드한다.

본 문서의 가이드는 C 언어를 대상으로 하고 있으며 C99 표준이 적용된다(추후 C11 등 최신 표준으로 변경 적용 가능하며, 이에 따라 본 문서의 내용이 일부 변경될 수 있다).

본 문서의 가이드는 구글 C++ 코딩 스타일 가이드(https://google.github.io/styleguide/cppguide.html)를 기반으로 내부적인 필요에 따라 일부 내용을 수정, 변경하여 적용한 것이다.

 

함수

짧은 함수

F-1. 짧고 집중된 함수를 작성한다.

함수가 40 줄을 넘어가면 프로그램의 구조를 해치지 않는 범위에서 함수를 나눌 수 있도록 노력한다.

긴 함수가 지금은 잘 동작 하더라도, 누군가 나중에 새로운 동작을 넣을 수 있으며, 이로 인해 찾기 힘든 버그가 발생할 수 있다. 

함수를 짧고 간단하게 유지하는 것은 다른 사람이 코드를 읽고 고치기 쉽게 만든다.

 

기타

상식적이고 일관성있게 작성한다.

코드를 수정하는 경우 잠시 주변의 코드를 살펴 그것의 스타일을 판단하고, 해당 코드와 일관성을 가지도록 작성한다.

 

 

이 스타일 가이드를 따르지 않는 기존 코드와의 일관성을 유지하기 위해 본 가이드라인을 따르지 않을 수 있다.