파카

클린코드, 형식 맞추기 본문

일지/독서

클린코드, 형식 맞추기

Anphaca 2022. 2. 10. 15:57
코드 자체가 최고의 구현 표준 문서가 되는 예다

본문을 보면 코드를 신문 기사처럼 작성하라고 한다. 

프로그래밍에 적용하면 아래와 같다.

- 이름은 간단하면서도 설명이 가능하게 짓는다.

- 첫 부분은 고차원 개념과 알고리즘을 설명한다.

- 아래로 내려갈수록 의도를 세세하게 묘사한다.

- 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

 

경험적으로 완전히 아 이거구나 하진 않았지만 공감가면서도 

아 이렇게 해봐야지 하고 생각하게 만들어준다. 

책을 읽으면서 잠시나마 생각을 정리할 수 있는 것은 좋은거 같다. 

 

마지막으로.. "프로그래머는 공동저자이면서 독자가 되어주는 동료들과 같이 일하는 사람이다"라고 알려주는 것 같다.

읽으면서 정말 글짓기를 하는 것처럼 잘 작성하는 습관을 통해 잘 읽히도록 만들어야 한다는 것을

다시 한 번 생각하게 되었다

 

이번 챕터 소감 및 요약

- 프로그래머에게 코드란 성의를 다해서 작성한 글이자 문서다.

- 한 소스파일에서 봤던 형식이 다른 파일에도 쓰일 수 있다. 그러므로 형식을 잘 작성해서
  좋은 재사용성이 발생하도록 노력해야한다.

- 나 스스로 형식이 일관적이도록 습관화하자.

'일지 > 독서' 카테고리의 다른 글

클린코드, 오류처리  (0) 2022.03.03
클린코드, 객체와 자료구조  (0) 2022.02.16
클린코드, 주석  (0) 2022.02.04
클린코드, 함수  (0) 2022.01.29
클린코드, 의미있는 이름  (0) 2022.01.26
Comments