오늘 TIL 요약
- 신문 기사처럼 작성하라
5장. 형식 맞추기
책에서 기억하고 싶은 내용
-
신문 기사처럼 작성하라(p.98)
일반적으로 큰 파일보다 작은 파일이 좋다.
신문기사는 표제로 기사 내용을 간략히 설명하며, 첫 문단에 전체 기사내용을 요약한다.
소스 코드도 이름은 간단하면서 설명이 가능하게 지어야한다.
첫부분은 고차원 개념과, 알고리즘을 설명하고 하위로 갈 수록 세세해야한다. -
변수 선언(p.101)
변수는 사용하는 위치에 최대한 가까이 선언한다. -
인스턴스 변수(p.103)
잘 설계한 클래스는 많은 클레서 메서드가 인스턴스 변수를 사용하므로 인스턴스 변수는 클래스의 맨 처음에 선언한다. (보통 자바에서) -
종속 함수 (p.104)
한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. -
가로 공백과 밀집도 (p.108)
공백을 넣으면 한 개념이 아니라 별개로 보인다.
totalChars += lineSize;
왼쪽 요소와 오른쪽 요소를 공백으로 나누어 두 요소가 확실히 분리 되어있음을 나타낸다.
totalChars.addLine(lineSize.lineCount);
함수와 인자는 밀접한 관계이므로 공백을 두지 않았다.
소감
다른 장에 비해 가볍게 읽은 파트였다.
이유는 너무나 많이 들은 조언때문이 아닐까..
대부분의 내용이 회사에서 상사가 해준 말들이었다.
그럼에도 언제부터인가 '짧은 코드가 좋은 코드'라는 이상한 개념이 나에게 잡혀있었는지 책에서 말한 개념은 빈 행으로 분리하라라는 법칙은 관성적으로 무시한적이 있다.
아주 안좋은 습관이라는 것을 인정하고, 앞으로는 짧은 코드보다는 가독성!!!을 명심해야겠다.
술 취한 듯한 코드, 무성의한 코드는 다른 측면도 무성의하다고 느껴질 것이다.
깔끔하고 일관적인 코드를 작성하자.
화이팅
