TIL 26: Xcode 파일 Header Comment 통일

TL;DR

• Xcode는 파일 Header Comment 포맷을 정의하는 방법을 제공한다.
• 파일 Header Comment 포맷을 통일해 프로젝트의 일관성을 유지하자.

파일 Header Comment의 일관성을 유지하자

언제나 Naming을 열심히 고민하는 개발자들에게 일관성 유지는 중요한 마음가짐이자 규칙이다.
파일을 생성할 때마다 상단에 추가되는 Header Comment도 그것의 예외가 될 수 없다.

기본적으로 Xcode에서 제공하는 파일 Header Comment 포맷에는 파일명, 프로젝트명, Copyright, 작성자 등이 포함된다. 일반적으로 저것으로 충분할 것으로 보이지만, 사내에서 여러 개발자가 파일을 생성하다보면 일관성이 깨지는 상황이 발생할 수 있다. 그것은 특히 작성자의 아이디가 알 수 없는 이름으로 되어 있거나 파일명을 수시로 바꾸는 경우다.

개발 환경을 설정할 때 임의의 애플 아이디로 로그인 해서 개발을 시작하거나 사내에서 쓰지 않는 자신만의 아이디를 쓰는 등과 같이 직접 확인하지 않으면 일관성이 깨지고 중구난방이 될 수 있다. 또한, 파일명이 이상해 리팩토링을 통해 고치거나 하면, Header Comment도 같이 바꾸는 게 정석이지만 빼먹고 변경하지 않는 일이 허다하다. 후자의 경우는 코드 리뷰나 개발자 스스로가 신경써서 관리해야 하겠지만, 전자의 경우는 사내 파일 Header Comment 규칙을 바꾸는 것도 한 방법이 될 수 있다.

협업을 하다 보면 하나의 파일을 여러 개발자가 건드리는 경우가 많으므로, 굳이 작성자를 명시할 필요가 없다. 또한, 커밋 내역을 통해 누가 무엇을 어떻게 수정했는지 파악할 수 있다. 따라서 작성자를 파일 Header Comment에 포함시킬 필요가 없었고, 일관성을 유지하기 좋은 방향으로 포맷을 수정할 필요가 생겼다.

다행히 Xcode에 파일 Header Comment 포맷을 변경할 수 있는 방법이 다양하게 존재했고, 사내 프로젝트를 위해서는 xcshareddata에 보관하는 방식으로 다른 개발자에게도 동일한 규칙을 적용시킬 수 있었다. 이 곳에서 포맷에 적용할 수 있는 다양한 매크로를 확인할 수 있다.

어찌보면 사소한 일이지만, 이 사소한 일이 다양한 인적 실수를 방지하고, 퀄리티를 높이는 등 좋은 장점이 있다고 생각한다. 얼른 다른 프로젝트에도 적용해야겠다. 😎