Community

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

← Go back
[TIL] 4. 주석
#clean_code
2년 전
542


TIL (Today I Learned)

2022.02.24

오늘 읽은 범위

4장. 주석

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

  • 나쁜 코드에 주석을 달지마라 새로짜라(p68)

  • 코드로 의도를 표현하라(p69)

if ((employee.flags & HOURLY_FLAG) && (employee.age > 65)) --->( x)

-> if (employee.isEligibleForFullBenenfits())

  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라(p84)

// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?

if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem())

->

ArrayList moduleDependees = smodule.getDependSubsystems();

String ourSubSystem = subSysMod.getSubSystem();

if (moduleDependees.contains(ourSubSystem))

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

  • 첫직장에서 자바코드와 자바스크립트 코드를 보는데 주석이 몇백줄이 넘어가는 것을 보고 코드보다 주석이 더 많을수가 있을까? 라는 의문이 들었던 적이있었다. 또, 코드를 수정할때마다 변경한 코드에 주석으로 변경한사람/변경날짜를 적어 두어 더 코드를 더럽게 했던 프로세스로 일을 진행했다. 형상관리 프로그램을 통해서 로그를 관리하지만 이렇게 작업을 하는 이유를 알 수 없었다. 이 책을 읽고 그 때 그 회사에서 1년동안 배운것보다 4장에서 주석을 어떻게 처리해야하는지 그리고 주석이 없어도 코드로 의미를 어떻게 표현해야하는지를 배울 수 있었다.

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