Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL-Assignment #06(2022.02.24[목])
#clean_code
2년 전
562

TIL-Assignment #06(2022.02.24[목])

TIL (Today I Learned)

2022.02.4

오늘 읽은 범위

4장 - 주석 67 Page ~ 94 Page

책에서 기억하고 싶은 내용을 써보세요.

  • 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다. ( 68p )

  • 진실은 한곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는(간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다 ( 69p )

  • 의무적으로 다는 주석

    • 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다. ( 80p )

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

  • 주석은 줄이는게 좋다. 내가 코드를 잘짜고, 네이밍을 잘 지켰더라면, 주석이 제거가 된다고하더라도 , 네이밍을 보고서 한번에 구분을 지을 수 있기에 네이밍 또한 같은 주석이라고 생각된다.

  • 경고를 사용하는 주석, 테스트 코드에 사용되는 주석, TODO가 있는 주석 모두가 각자의 맡은 역할이 있는 주석이 있다. 이러한 주석을 사용함으로써 같은 개발자에게 더 이해하기 쉬운 코드로 전달 될 수 있을 것이다.

  • 요즘에는 git을 사용하여 코드관리를 하기 때문에, 굳이 모듈이나 코드에 주석으로 해당하는 변경내용을 적지 않아도 되는것이다.

  • 함수 한줄 한줄에 적는것 보다, 주석 또한 리펙토링을 걸쳐 주석은 한곳에 몰아 사용하고, 그 주석이 의미하는 바가 명확해야 된다는 것이다.

  • 주석은 nearby에 있는 함수에만 작성하는 것이 좋은 것이다. 근처가 아닌 전역으로 깔리는 주석은 결코 의미는 없는건 아니지만 의도와 의미를 방해하는 요소로 포함이 되는 것이다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

  • 함수나 변수로 표현할 수 있다면 주석을 달지 말라고 한다. 결국에는 영어실력이 높은 수준으로 올라가야 한다는 의미가 아닌가.... 네이밍 규칙을 지키는 컨벤션이 있기 때문에 이러한 네이밍에서는 많은 도움이 될거라고 생각되지만, 남이 작성한 함수명이나 변수명이 이해가 되지 않을 때는 분명 있으리라 생각한다.