소스코드
-
소스코드에 주석은 어느 정도로 활용되어야 할까?Today I Learned 2023. 5. 26. 03:38
(해당 글은 저서 'Docs for Developers'를 참고하여 작성했으나, 다소 주관적인 견해를 담고 있습니다. 다른 견해가 있으실 경우 자유롭게 제안해주시면 감사하겠습니다.) 시간이 지나면 나조차도 내 코드를 이해하기 어렵게 된다. 프로젝트를 진행하면서 가졌었던 생각 중 하나로, 주석을 아예 작성하지 않고 단지 코드를 읽는 것만으로도 이해할 수 있는 소스코드를 작성할 수 있어야 한다는 생각이 있었다. 이를 위해 코드를 작성할 때 줄곧 다음과 같은 것들을 고려했었다. - 축약어를 사용하지 않는다. ex) a, b, i, idx, cnt, ... - 변수, 메서드 등을 네이밍할 때는 의미를 최대한 나타낸다. 이 규칙들을 지킨다고 해서 항상 읽기 좋은 코드가 만들어지지는 않았다. '의미를 최대한 나타내..