일 하면서 코드를 짜다가 올바르게 주석을 다는 법에 대해 문득 궁금해졌다. 싸피에서 프로젝트를 하면서 시간 없다는 핑계로 주석을 달지 못할 때도 있었지만, 코드를 다시 보면서 공부하는 편인 나 스스로를 위해서라도 주석을 충분히 다는 편이었다. breadcrumbs를 수정하면서 코드를 대폭 수정하면서도 주석을 거의 코드 단위로 달고 있었는데, 회색 주석이 빽빽하게 있는 화면을 보면서 주석이 많은 게 꼭 좋지는 않을 것 같다는 생각을 했다. 하지만 내 뇌피셜만 믿고 넘어갈 수 없었기에 '주석 잘 다는 법'을 구글링해보니 그 유명한 클린코드에 한 장을 할애해서 적혀 있었다. 아직 클린코드를 읽어 보지 못헀지만 잘 정리한 글이 있어서 북마크!
'Programming > ETC' 카테고리의 다른 글
백도어(Back Door)란? (0) | 2023.02.02 |
---|---|
[클린 코드] code-review-tips by Ryan McDermott(구글 엔지니어) 번역 (2) | 2023.01.18 |
새줄 문자(newline) Carrige Return, Line Feed, CRLF (0) | 2022.12.27 |
'export default function', 왜 쓰는 걸까? (0) | 2022.12.21 |
내가 만든 페이지를 web server에 띄우고 싶을 때, 'serve' (0) | 2022.12.20 |
댓글