작심삼일 개발이야기

4장. 주석 4장의 포인트 주석이 과연 좋을까? 솔직히 소제목만 읽어도 4장을 다 읽은 거나 다름이 없다. 주석은 나쁜 코드를 보완하지 못한다 주석 대신 코드를 사용해서 의도를 충분히 전달 가능하다. 주석을 달아야겠다는 것은 코드를 정리하라는 신호이다. 코드로 의도를 표현하라! 주석을 사용할 것이면 주석 대신 함수로 표현해라 예를 들어 긴 계산식을 적어놓고 주석을 달지 말고 함수로 만들어서 함수명으로 알아보기 쉽게 해라 좋은 주석 법적인 주석 정보를 제공하는 주석 의도를 설명하는 주석 의미를 명료하게 밝히는 주석 결과를 경고하는 주석 TODO 주석 중요성을 강조하는 주석 가장 와닿는 주석은 TODO 주석이다. TODO 주석을 위한 extenstion도 설치했었다. 하지만 TODO주석도 주석이므로 주기적으..

이 글은 "개발자의 글쓰기"를 읽고 좋은 구절들을 기록하거나 느낀 점을 기록하는 글입니다. 1. 네이밍 컨벤션, 이유를 알고 쓰자 어떤 방법으로 이름을 정하던 중요한 것은 표기법 자체가 아니라 사용하는 이유다. 많은 컨벤션이 생긴 이유는 가독성과 개발자들 사이의 소통 때문이다. 어떤 방법이든 좋다. 같이 일하는 팀원들과 컨벤션을 정하고 지키도록 노력해보자 2. 변수 이름을 잘 짓는 법 책에서 알려주는 방법 중 한 가지 방법은 중요한 단어를 앞에 쓰라고 한다. 개발 도구가 단어를 검색하면 다 잘 찾아주기 때문에 크게 의미가 없을 수도 있지만 중요한 것이 앞에 와야 한다는 기본 원칙을 지키라고 한다. 함수 이름은 1함수 1 업무 규칙을 적용해라(하나의 함수에서 한 가지 일만 해라) 3. 좋은 이름의 기준, ..

이 글은 클린 코드를 읽고 좋은 구절들을 기록하거나 느낀 점을 기록하는 글입니다. 주석은 나쁜 코드를 보완하지 못한다. 코드를 작성하다 주석을 사용할 때는 다른 사람 또는 내가 코드를 볼 때 알아보기 힘들 거 같다고 예상이 들면 주로 주석을 작성한다. 사실 이건 주석으로 때우려고 하지 말고 코드를 고쳐야 하는 것이 맞다 하지만 역시 주석을 달고 도망가버리곤 했다.. 좋은 주석 TODO 주석 가끔 코드를 보다보면 //TODO 주석을 본 적이 있다. 말 그대로 필요하지만 당장 구현하기 어려운 일들을 기술하는 주석이다. 더 이상 필요 없는 기능을 삭제하라거나 더 좋은 이름을 생각해달라는 부탁 앞으로 어떻게 고쳐야 한다는 주의 등에 유용하다. 나쁜 주석 대다수의 주석들이 나쁜 주석들이다. 물론 아닌 사람도 있겠..