-
범위
04 주석 -
클린코드의 세계
이번 챕터에서는 개발자들이 코드를 설명하기 위해 다는 주석에 대해 알아보고 나쁜예시들과 좋은 예시들을 살펴봤다.-
나쁜코드에 주석을 달지마라, 차라리 설명이 필요없게 새로짜라
-
부정확한 주석은 독자를 현혹하고 오도한다.
-
난장판을 주석으로 설명하려 애쓰는 대신에 난장판을 치우는데 시간을 보내라
필요한 주석
- 정보를 제공하는 주석
- 결과를 경고하는 주석 or "@Ignore"
- 중요성을 강조하는 주석
필요없는 주석
- 새로운 정보를 주지않고 당연한 사실을 열거하는 주석
- 괄호에 다는 주석 => 작고 캡슐화된 함수에는 오히려 잡음
함수를 줄이려 시도하는것이 훨씬 더 효율적임
-
이 책은 결국 하나의 길로 보내주기 위해 어마무시하게 구체적이고 친절하게 도와주고 있는듯 했다. 하지만 처음부터 모든걸 적용해서 코드를 작성하는것은 불가능에 가깝고 리팩토링하며 수정해 나가야한다. 그때 참고하면 너무 좋은 참고서같다.
Nicolas의 TIL 참고하기
-
사람들은 언젠가 코드가 자동으로 생성될 것이라 말하지만, 그렇지 않아. 실상은 언어의 추상화 수준이 DLS 와 함께 계속 높아질 것이고 이는 좋은 것이지. 코드가 사라질 것이라 생각하는 것은, 마치 우리가 원하는 것을 말하지 않아도 척척 해내는 기계가 있을 것이라 생각하는 것과 같아. 살아남고자 한다면, 우리는 반드시 깨끗한 코드를 작성해야 해. 가장 좋아하는 인용구: “Clean code always looks like it was written by someone who cares.” M. Feathers.
-
코드를 작성할 때 우리는 독자를 반드시 염두하는 작가라는 것을 기억해야 해. 왜냐면, 우리는 코드 작성보다, 읽는 것에 더 많은 시간을 할애하게 되어있으니까! 우리는 진공 상태에서 코드를 작성하지 않고, 주변의 모든 논리를 읽고 작성하지. 즉. 읽기 쉬운 코드를 쓰는 것은 코드 작성도 쉽게 하는 셈이야. Entropy in code also exists, code rots.
-
We will never get rid of code, even if people think that one day all code will be generated instead of written. Instead, the level of abstraction of languages will continue to increase along with DLS’s which is a good thing. Thinking that code will disappear is like thinking that one day there will be machines that do what we want and not what we say. If we want to survive, we need to clean the code. Favorite quote: “Clean code always looks like it was written by someone who cares.” M. Feathers.
-
When we write code we must remember that we are authors writing code for our readers, who will judge us by our effort. Because we will spend more time reading code than writing it, we want to make the reading as easy as possible. When we write code we are not doing that in a vacuum, we are writing code by reading all the surrounding logic so that means that by making code easy to read we also make it easy to write. Entropy in code also exists, code rots.
오늘 읽은 다른사람의 TIL
1. https://hoya-develop.tistory.com/entry/3-%EB%85%B8%EA%B0%9C%EB%B6%81-CleanCode-3-4%EC%9D%BC%EC%B0%A8
2. https://daehun.notion.site/TIL-4-of-22-3-e5d179d1ced94108a6d78d11762b397e
