좋은 주석을 적는 방법

1. 코드 내용을 그대로 반복하는 (추가 정보가 없는) 주석은 적지 말라. 2. 좋은 주석은 불명확한 코드를 변명하지 않는다. - 주석으로 코드를 설명하지 말고 코드를 다시 써라. 3. 명확한 주석을 적을 수 없다면 코드에 문제가 있을 수 있다. - 코드가 어렵다고 주석으로 경고하지 말고 코드를 다시 써라. 4. 주석은 혼란을 야기하는 것이 아니라 해소해야 한다. - 주석을 보고 더 헷갈린다면 그 주석은 지워라. 5. 관용적이지 않은(unidiomatic) 코드는 주석으로 설명하라. - 불필요하거나 중복된다고 생각할 수 있는 코드, 이로 인해 다른 누군가가 "단순화"할 수도 있다고 생각되는 코드에는 주석을 달아 설명하는 것이 좋다. 6. 복사한 코드라면 원본 출처 링크를 주석에 포함하라. - 향후 코드를 읽을 동료가 전체 컨텍스트(어떤 문제, 해당 솔루션이 권장되는 이유 등)를 파악하는 데 도움이 될 수 있음. 7. 도움이 될만한 외부 참조 링크를 포함하라. 8. 코드를 수정할 때, 특히 버그를 수정할 때 주석을 추가하라. 9. 주석을 사용해 불완전한 구현을 표시하라. - 기술 부채를 측정하고 해결하는 데 도움이 됨. https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/

Best practices for writing code comments

Stack Overflow Blog

Best practices for writing code comments

다음 내용이 궁금하다면?

또는

이미 회원이신가요?

2023년 5월 27일 오전 5:29

 • 

저장 301조회 11,311

댓글 0

    함께 읽은 게시물

    < 가장 예쁜 사람이 아니라, 1등 할 사람에게 투표하라 >

    1. 유명한 경제학자 케인스는 단기 투자 전략을 미인선발대회에 비유했다.

    ... 더 보기

    기술, 개발 학습 자료 7가지

    최근 자주 사용하고 있는 기술, 개발 및 자기 계발 학습 자료를 모아서 공유합니다. 1️⃣ Educative.io 퀄리티가 상당히 높은 기술 관련 코스가 많은 것 같아요. 현재까지 코스 3개를 들었습니다. 책처럼 읽으면서 배우는 코스라 듣는 것보다 읽으면서 학습하는 걸 선호하는 분들에게 추천합니다. 주제를 깊이 파고들고 코드나 설계 예시가 많아서 잘 사용하는 것 같습니다. 최근에 Concurrency관련 코스를 듣고 있습니다. https://www.educative.io/ 2️⃣ Designing Data Intensi... 더 보기

    Educative: Interactive Courses for Software Developers

    Educative

    Educative: Interactive Courses for Software Developers

     • 

    댓글 9 • 저장 956 • 조회 22,026


    올해로 개발자 생활이 햇수로 20년째다

    2005년 7월에 일을 시작했으니, 올해로 개발자 생활이 햇수로 20년째다. 중간에 공백이 조금씩 있었으니 꽉 채운 스무 해는 아니지만, 숫자가 주는 무게는 여전하다. 20년이라는 시간이 흘렀다는 사실이 새삼 신기하게 느껴진다.

    ... 더 보기

    야근의 관성

    제가 한국에서 직장 생활을 시작하고 가장 먼저 배운 것은 아이러니하게도 야근이었습니다. 신입이었던 제게 야근은 선택의 문제가 아니었거든요. 선배들에게 야근은 너무나 당연한 루틴이었고, 저녁 5시가 되면 "퇴근 안 해?"가 아니라 "저녁 뭐 먹을까?"라는 질문을 던졌습니다. 누가 정해놓은 것처럼 부장님이 퇴근해야 과장님이, 과장님이 퇴근해야 대리님이, 대리님이 퇴근해야 비로서 저 같은 신입도 퇴근 생각을 할 수 있었습니다.

    ... 더 보기

     • 

    저장 15 • 조회 3,774


    성장이 어려운 환경에서의 개발자 생활

    저런 개발자 생활도 한적이 있어서 다양한 생각이 든다.

    “어이 신입, 탈출각이다” | 요즘IT

    요즘IT

    “어이 신입, 탈출각이다” | 요즘IT

    길은 잃은 이력서

    

    ... 더 보기