요즘엔 마케터분들도 분석가들도 조금의 코딩을 하시면서 프로그래밍 지식 공부도 많이 하고 계시죠? 비즈니스 문서만큼 코드도 여러명이 작성하게 되는 경우가 많은데요. 일관성있고 명확한 '주석달기' 는

요즘엔 마케터분들도 분석가들도 조금의 코딩을 하시면서 프로그래밍 지식 공부도 많이 하고 계시죠? 비즈니스 문서만큼 코드도 여러명이 작성하게 되는 경우가 많은데요. 일관성있고 명확한 '주석달기' 는 원활한 협업과 안정적인 시스템 유지, 디버깅에 아주 중요한 것 같습니다. 이와 관련하여 좋은 글이 있어 공유합니다. "프로그래머가 더 나은 코드를 작성하는 데 도움이 되는 리소스는 많지만 더 나은 주석을 작성할 수 있는 리소스는 거의 없습니다. 프로그램에서 주석의 양을 측정하는 것은 쉽지만 '품질'을 측정하는 것은 어렵고 두 가지가 반드시 상관관계가 있는 것은 아닙니다. 나쁜 주석은 아예 댓글이 없는 것보다 나쁩니다." 주석달기의 중요한 규칙들. 규칙 1: 주석은 코드를 복제해서는 안 됩니다. 규칙 2: 좋은 주석은 불분명한 코드를 변명하지 않습니다. 규칙 3: 명확한 주석을 작성할 수 없다면 코드에 문제가 있을 수 있습니다. 규칙 4: 댓글은 혼란을 야기하는 것이 아니라 혼란을 없애야 합니다. 규칙 5: 주석으로 단방향 코드를 설명하십시오. 규칙 6: 복사된 코드의 원본 소스에 대한 링크를 제공합니다. 규칙 7: 가장 도움이 될 외부 참조에 대한 링크를 포함합니다. 규칙 8: 버그를 수정할 때 주석을 추가합니다. 규칙 9: 불완전한 구현을 표시하려면 주석을 사용하십시오.