좋은 주석을 적는 방법

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,309

댓글 0

    함께 읽은 게시물


    🪄 플레이모어와 함께할 동료를 찾습니다

    ... 더 보기

    플레이모어와 함께할 동료를 찾습니다 | Notion

    playmoreai on Notion

    플레이모어와 함께할 동료를 찾습니다 | Notion

     • 

    저장 7 • 조회 3,125


    데이터 엔지니어로 성장하고 싶다면~

    🍀 데이터 엔지니어란? 소프트웨어 엔지니어링과 프로그래밍의 업무 역량 사이의 간극을 메우는 전문가로 데이터 엔지니어는 고급 분석 기술, 강력한 프로그래밍 기술, 통계적 지식, 빅데이터 기술에 대한 명확한 이해를 갖춘 사람입니다. 🍀 데이터 엔지니어는 어떤 일을 하나요? 정형 및 비정형 데이터에 쉽게 액세스할 수 있는 데이터 인프라를 설계, 관리, 테스트, 유지, 저장하고 작업을 하며, 대규모 데이터 처리를 탐색하고 확장 가능하고 안정적인 작업 환경을 보장하기 위해 전문 지식과 소프트 스킬 필요 🔱 서버와 애플... 더 보기

    15+ Must Have Data Engineer Skills in 2023

    Knowledgehut

    15+ Must Have Data Engineer Skills in 2023

    🎉 벤처기업 인증 완료! 🎉

    ... 더 보기

    플레이모어와 함께할 동료를 찾습니다 | Notion

    playmoreai on Notion

    플레이모어와 함께할 동료를 찾습니다 | Notion

    [팟캐스트] 신입에게 대규모 트래픽? 이런걸 원하는거에요!

    ... 더 보기

    - YouTube

    youtu.be

     - YouTube

    대량의 트래픽이 몰려올 때 나는 어떻게 해야하나? - (feat. Cac

    🌱 0. 들어가며

    ... 더 보기