ETC/Books

[Clean Code] 우리는 모두 author 이다.

Pazery는ENFJ 2021. 9. 29. 21:31
반응형
javadoc에서 @author 필드는 저자를 소개한다. 우리는 저자다. 저자에게는 독자가 있다. 그리고 저자에게는 독자와 잘 소통할 책임도 있다. -출처 Clean Code 내용 중-

오늘 읽었던 몇 안 되는 문장 중에 인상 깊었던 문장 중 하나입니다.

이 문장은 읽자마자 "꼭 포스팅해야지"라고 생각했습니다.

오늘 파트 후배가 본인이 받은 프로젝트에서 새로운 기능을 개발해야 하는데 legacy를 어떻게 활용해야 하는지, 어떻게 코드를 짜면 좋을지에 대한 질문을 했었는데, 그 질문에 두루뭉술하게 대답을 해줬었던 기억이 떠올랐습니다.

제가 했던 대답은

  1. 비슷한 기능을 하고 있는 코드에 의존하지말고 참고용으로만 생각하는 것이 좋다.
  2. 기존의 코드를 얼마나 잘 활용했는지가 중요한게 아니라 구현하고자 하는 기능이 정상적으로 동작하는 것이 중요하다.
  3. 공통으로 사용하는 클래스나 함수는 수정하지 않는 것이 좋다. (다른 코드의 영향도 어쩌구 저쩌구 하면서 얘기한 것 같음)

정도로 대답했던 것 같습니다. 아! 그리고 최근 읽기 시작한 이 책에 대해서도 간단이 이야기를 했던 것 같아요.

나열을 하려다보니 조금은 더 정리된 표현(?)으로 얘기한 것 같지만 실제로 얘기할 때에는 저렇게 얘기를 하지 않고 저런 의도를 갖고 이야기를 했었습니다. 지금 다시 보니까 너무 당연한 얘기만 했었네요 😂

갑작스러운 질문에 당황해서 답변 봇처럼 이야기를 했었나봅니다😭

 

만약! 오늘 위에 인용해둔 책의 한 부분을 읽은 후 였다면 "00님이 아닌 다른 사람이 읽기 쉽게 짜면 좋을 것 같다" 라는 말도 해줬을 것 같아요. 이 책에도 나오지만 우리가 코드를 짜는 시간과 코드를 읽는 시간을 비교했을 때 코드를 읽는 시간이 코드를 짜는 시간보다 훨씬 길기 때문이죠. 오늘 저도 수정할 코드가 있었는데 실제로 코딩과 디버깅에 쏟은 시간은 얼마 안되지만 코드를 읽는데 하루의 대부분을 썼거든요

 

새로운 페이지나 함수 등을 만들때 상단에 @author 하면서 제 이름과 파일을 작성할 일자를 기록하곤 하는데, 단순히 다른 문서와 형식을 맞추기 위해서 @author : kevin이라고 쓰는 게 아니라 "나는 저자다."라는 마음가짐으로 조금 더 책임감 있는 코딩을 해야겠다는 생각이 듭니다.

 

 

주변 코드를 읽기가 어려우면 새 코드를 짜기도 어렵다. 그러므로 급하다면, 서둘러 끝내려면, 쉽게 짜려면, 읽기 쉽게 만들면 된다.
- Clean Code 중 -
반응형