210304_B책_지나치게 많은 주석 없애기

정재현·2021년 3월 4일
0

TIL2

목록 보기
4/79

2장이 끝나고 3장에 들어간다.
2장에서는 매직 넘버를 어떻게 처리하는지, 상황에 따라 상수나 enum으로 교체하는법,
요구사항에 잘 맞게 순회하며 예외나 성능저하를 피하는법, 코드를 읽기 쉽게 서식화하여 API를 사용하는법을 배웠다.
여기서 멈추지 않고 내가 이 코드가 다른 상황에서도 똑같이 유효할까? 라는 의문점이 생기면
자바API를 찾는 노력을 하라고 한다.
=>(실제로 오늘 업무하다가 API를 사용해볼까 생각을 했는데, 구현에 앞섰다. 나쁜 시도는 아니였지만 원하는 만큼의 퀄리티가 나오질않았고, 결국 그 코드를 초기화시켰는데.. API를 찾아볼껄.. 싶다 ㅠㅠ)

3장에서는 코드 주석이라는 프로그래밍의 한 측면을 더 구체적으로 설명하고 확장하는 장이다.
대부분의 프로그래머는 주석을 별로 신경쓰지 않지만 훌륭한 주석은 코드의 가독성에 엄청난 차이를 불러옵니다.
=>(역시 오늘 업무하다가 느낀점인데, 몇 분을 봐도 왜 이 코드가 있지? 라는 생각이 들 때가 자주 있다. 이럴 때 주석을 잘 활용하면 굳이 코드리뷰, 소통을 하지않고 바로바로 작업을 이어갈 수 있으니 좋다.)

3장. 슬기롭게 주석 사용하기

  • 훌륭한 코드는 그 자체로 최고의 설명서다. 주석을 추가하기 전에
    "주석이 필요없도록 코드를 향상시킬 방법이 없을까?" 라고 자문해보자.

3.1 <지나치게 많은 주석 없애기>
초보자들에게 지나치게 많은 주석은 난 좋다고 생각한다.
오히려 원래있는 코드에 주석을 달아보면서 나는 코드를 이해했었다.
책에서는 코드를 한줄만 읽으면 알 수있는 주석, 코드 블록의 끝을 표시하는 주석은 모두 없앴다고 한다.
그렇다면 주석은 언제 다는것이냐!?
예외를 발생한다거나, 발생시키는 방법을 설명할 때 쓰면 좋다고 한다.
또한 코드에 뭔가를 덧붙여 설명하지 않는 주석은 쓸모없는 주석이라고 봐도 무방하다고 한다.
=>(하지만 나는 코딩하는 사람이 이 코드를 읽는 사람을 위해서 이건 주석써줘야겠는데? 라고 생각이 든다면 써도 된다고 생각한다. 왜냐하면 그 코드를 제일 잘알고 의도한 사람은 자기 자신일테니깐.)

주석 내용은 가볍게 읽혀서 정리를 간단하게 한다.

오늘의 코멘트: 책으로 배우고 업무를 하니 업무할 때도 확실히 적용을 하려고 노력하고 있다.

profile
"돈받고 일하면 프로다"

0개의 댓글