이건 여러 형님들한테 배운 건데…(유명환님 외 여러 분들.) 리눅스 모듈이나 커널, 장치 드라이버같이 커맨드 라인 환경에서 코드를 작성하는 곳에서는 은근 잘 이용하고 있다.
프로그램 개발하면서 함수나 변수, 클래스 등의 이름 작명하는 것을 엄청나게 잘 한다면 “아, 이게 이게 이 함수였지?” 라고 하면서 잘 알 수 있겠지만 하다보면 여기저기 막 정리가 잘 안되어서 이름이 막 지어지는 경우가 많다. 이를 위해서 주로 문서로 정리를 하거나 주석을 달아두는데, 여러 사람들이 건드리는 주석의 경우에는 어떤 사람이 작성한 주석인지를 작성한 사람의 아이디(닉) 혹은 이메일을 작성하여 두는 것이다. 예를 들면 이런 거다.
// kyuling(1.0): 가상 메모리에서 특정 값들을 덤프해둘 구조체
// odaka(1.1): 連続したメモリ情報を読み込むためのポインタを変更
struct dump_vm_memory
{
….(불라불라)…
};
이전에 짜고 있던 프로그램의 자료구조이다. 여기 보면 내가 제일 처음 개발했던 버전에서 선언해서 사용했던 것인데, 이 것을 odaka라는 분이 성능 향상을 위해 수정을 해 주었다. 그때 달아주었던 주석인데, 이 주석 내용하고 코드를 같이 diff해서 보면 좀 더 편하게 볼 수 있었다.
사실 그냥 IDE에서 보면 쉽게 적용되는 것들이기도 하고, 프로젝트 관리를 하다 보면 금방 확인할 수도 있는 건데 이걸 왜 이렇게 짜냐고 생각할 수도 있다. 근데 이건 은근 중요했다. 주석에 의해 정보를 잘 남기는 경우라거나 주석으로 알리고자 하는 것들이 있을 경우에는 어떤 사람이 남겼는지를 알 수 있다는 것도 중요했고, 그냥 find로 해당 아이디를 찾아 들어가면 어떤 사람이 생성, 수정을 했던 기록을 찾아보는 것 또한 쉽게 할 수 있었다.
뭐, 이것도 습관이 들어야 잘 써먹는 것이긴 하다. 되게 번거롭게 작업한다고 생각하는 사람들 또한 있을 것이다. 하지만, 적응 잘 되면 좋은 노하우라고도 생각되기 때문에 한번 적어봤다.