Ch4. 주석 나쁜 코드에 주석을 달지 마라. 새로 짜라. 브라이언 W. 커니핸, P. J. 플라우거 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 사실상 주석은 기껏해야 필요악이다. 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라. 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. 그러므로 주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다. 상황을 역전해 코드로 의도를 표현할 방법은 없을까? 코드로 의도를 표현할 때마다 스스로를 칭찬해준다. 주석을 달 때마다 자신에게 표현력..

Ch3. 함수 작게 만들어라 함수를 만드는 첫째 규칙은 '작게!' 함수를 만드는 둘째 규칙은 '더 작게!' 얼마나 짧아야 하는가? 일반적으로 아래 예시 정도로 짧게 작성해야한다! public static String renderPageWithSetupsAndTeardowns( PageData pageData, boolean isSuite) throws Exception { if (isTestPage(pageData)) includeSetupAndTeardownPages(pageData, isSuite); return pageData.getHtml(); } 블록과 들여쓰기 즉, if / else / while 문에 들어가는 블록은 한 줄이어야 한다는 의미. 한 가지만 해라 함수..

Ch2. 의미 있는 이름 의도를 분명히 밝혀라 변수나 함수 그리고 클래스 이름은 다음과 같은 굵직한 질문에 모두 답해야 한다. 변수 (혹은 함수나 클래스)의 존재 이유는? 수행 기능은? 사용 방법은? 따로 주석이 필요하다면 의도를 분명히 드러내지 못했다는 것 의미 있게 구분해라 컴파일러나 인터프리터만 통과하려는 생각으로 코드를 구현하면 언젠가는 문제가 생기기 마련 연속된 숫자를 덧붙이거나 불용어(의미가 불분명하거나 없어도 되는 단어)를 추가하는 방식은 적절하지 못함 이름이 달라야 한다면 의미도 달라져야 한다. 변수의 이름으로 아무런 정보를 제공 받지 못하는 예시 public static void copyChars(char a1[], char a2[]){ for (int i = 0; i < a1.lengt..

나름 이런저런 언어를 이용해서 여러가지 개발을 하고 있는데, 매번 작업했던 코드를 볼 때마다 새로운 느낌을 지울 수가 없다. 아무리 주석이 잘 되어있더라도, 그 주석이 업데이트된 코드의 내용을 반영하고 있는지도 의문이다. 그나마 기억력이 내 몸에 있는 다른 기능들보다는 좋은 편이라 약간의 시간을 들이면 기능들을 복기하는데 어려움은 없지만 그래도 더 나은 코드, 더 좋은 코드를 작성해야겠다는 생각이 들었다. 많은 사람들이 클린 XX 시리즈는 개발을 하는 사람들이 더 나은 코딩 실력을 가지기 위해서 꼭 한 번 쯤은 읽어보면 좋은 책이라고 했다. 그래서 클린 코드와 클린 아키텍쳐, 총 2 권의 책을 구매하였다. 이 책들을 읽으면서 지금 내가 개발한 환경이나 코드들을 어떻게 수정할 수 있는지 고민하고 직접 변경..

c언어 공부할 때 기존에 작성해뒀던 마크다운 문서를 티스토리 에디터에서 제공해주는 마크다운에 복사해서 넣었는데 (원본: https://sunandbean.github.io/2020/01/09/c-01-array-1d/ -> 옮긴 페이지: https://sunandbean.tistory.com/185) 코드 블록이 어떤 언어로 인코딩 되어야 하는지 나타내주는 기능이 작동하지 않고, 헤더 사이즈가 제대로 동작하지 않는 것 같다 일단 기존에 작성된 방식을 그대로 옮겨두고 발행 예약 시켜둔 다음에 정보 좀 찾아보고 수정할 방법을 생각해봐야겠다. 확실히 코드 블록 작업할 때는 마크다운이 편하긴 하니까

이번 코로나 사태가 터지기 직전에 가까스로 회사에 입사할 수 있었다. 입사한 회사에서 내가 맡게 된 업무는 시뮬레이션 환경 구축이다. 대학교, 대학원 시절에도 다양한 시뮬레이션 환경을 구축해봤는데, 대부분 일회성 혹은 단기적으로 이용할 환경이어서 유지보수 보다는 기능 구현에 충실했었다. 시뮬레이션 환경 구축을 하면서, 내가 구축한 환경을 다른 "많은" 사람들도 불편함이 없이 써야한다는 고민을 회사에 와서 거의 처음해봤다. 이런 고민을 안고 개발한 환경의 코드를 보니 다른 사람들이 이용하기엔 너무 별로인 것 같아서 어떻게 하면 좋은 코드를 짤 수 있을지 고민하다 이 책을 찾게 되었다. http://www.kyobobook.co.kr/product/detailViewKor.laf?ejkGb=KOR&barco..