TIL (Today I Learned)

// 2022.01.22

오늘 읽은 범위

// 1장. 깨끗한 코드

책에서 기억하고 싶은 내용을 써보세요.

• 부정확한 주석은 독자를 현혹하고 오도한다. 더 이상 지킬 필요가 없는 규칙이나 지켜서는 안 되는 규칙을 명시한다. (p.69)

• 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야한다.(p.69)

• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!(p.69)

• 좋은 주석

-법적인 주석

-정보를 제공하는 주석

-의도를 설명하는 주석

-의미를 명료하게 밝히는 주석

-결과를 경고하는 주석

-TODO 주석

-중요성을 강조하는 주석

• 나쁜주석

-같은 이야기를 중복하는 주석

-오해할 여지가 있는 주석

-의무적으로 다는 주석

-있으나 마나 한 주석

-닫는 괄호에 다는 주석

-공로를 돌리거나 저자를 표시하는 주석

-주석으로 처리하는 코드

-전역정보

-너무 많은 정보

-모호한 관계

-함수 헤더

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

• 나에겐 주석이란 코드를 설명해 놓는 함축같은 것이었다. 그래서 주석이 필요하지 않아도 주석을 달았는데 사실 변수명이나,함수명등 이름을 잘 짓는다면 이름만 보고도 알 수 있는 것이기 때문에 주석이 필요 없었을 것이다. 지금에서야 알았다 주석이 무조건 필요한 것이 아니란 것을!!

• 나쁜 코드 중에 '닫는 괄호에 다는 주석' 이 있었다. 중첩이 심할 때 내가 헷갈려서 달았던 주석인데..나쁜 코드 예시라니...내 함수가 작고 캡슐화되지 못하고 한가지만 동작하는 코드가 아니여서 그랬겠지..?

• 나쁜 코드 중 주석으로 처리하는 코드...! 이것 또한 초반에 내가 테스트 용도로 사용한다고 달았던 주석이었다..하하

• 목,금이 주석에 대한 내용을 읽는 것인데 오늘 다 읽었다. 왜냐하면 내일 다시 읽어보기 위해서!!

내일 다시한번 읽어보자

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

• // 르블랑의 법칙? (LeBlanc's Law states) - "Later equals never" is used in the context of software development, but may be applied more broadly to other areas. The law is attributed to Dave LeBlanc.