[Nomad Coders Challenge] Clean Code - Assignment #03

 

 

📍 It is part of a book club challenge on a programming learning website called Nomad Coders. The challenge is to demonstrate what I have learned after reading Clean Code by Robert C. Martin.

 

📝 It will consist of the following sections over three weeks: the range of reading, the top quotes from the book, my review, and remaining questions. 

  🔗Challenge Schedule

---

💻  I plan to read Clean Code in JavaScript and Python, referring to the GitHub repositories shared by Nomad Coders with the challengers.

 

Assignment #03

• 📚 Chapter 2. Meaningful Names - Variables
• ✔️ TIL 
  • Top quotes from the book
  • My review
  • Remaining questions

---

 

📝 Top quotes from the book

• 의도를 분명히 밝혀라
  • 변수나 함수 그리고 클래스 이름은 다음과 같은 굵직한 질문에 모두 답해야 한다. 변수(혹은 함수나 클래스)의 존재 이유는? 수행 기능은? 사용 방법은? 따로 주석이 필요하다면 의도를 분명히 드러내지 못했다는 말이다.
  • 코드 맥락이 코드 자체에 명시적으로 드러나지 않는 것이 문제다.
• 그릇된 정보를 피하라

  • acountList (x) -> accountGroup, bunchOfAccount, Accounts (o)

  • 서로 흡사한 이름을 사용하지 않도록 주의한다. 
  • 일관성 유지 : 유사한 개념은 유사한 표기법을 사용한다. 
• 의미있게 구분하라 
  

  class Product -> class ProductInfo, class ProductData (x)
  class Customer, class CutomerObject (x)

• 발음하기 쉬운 이름을 사용하라
  
  • 프로그램은 사회 활동이기 때문이다.
• 검색하기 쉬운 이름을 사용하라 -  문자 하나를 사용하는 이름과 상수
• 자신의 기억력을 자랑하지 마라
  • 전문가 프로그래머는 명료함이 최고라는 사실을 이해한다. 전문가 프로그래머는 자신의 능력을 좋은 방향으로 사용해 남들이 이해하는 코드를 내놓는다.
• Class Name - Noun, Noun Phrase
  

  e.g) Customer, WikiPage, Account, AddressParser (o)
  Manager, PRocessor, Data, Info (x)

• Method Name - Verb, Verb Phrase
  

  e.g) postPayment, deletePage, save (o)

• 한 개념에 한 단어를 사용하라
  • 추상적인 개념 하나에 단어 하나를 선택해 이를 고수한다. 
• 한 단어를 두 가지 목적으로 사용하지 마라. 다른 개념에 -> 같은 단어 (x)
  • 프로그래머는 코드를 최대한 이해하기 쉽게 짜야 한다. 집중적인 탐구가 필요한 코드가 아니라 대충 훑어봐도 이해할 코드 작성이 목표다. 의미를 해독할 책임이 있는 독자에게 있는 논문 모델이 아니라 의도를 밝힐 책임이 저자에게 있는 잡지 모델이 바람직하다.
• Name Based on Domain (x) -> Use computer science (CS) terms, algorithm names, pattern names, or mathematical terms.
• 여느 코드 개선 노력과 마찬가지로 이름 역시 나름대로 바꿨다가 누군가는 질책할지도 모른다. 그렇다고 코드를 개선하려는 노력을 중단해서는 안 된다.
• 이 장에서 소개한 규칙 몇개를 적용해 코드 가독성이 높아지는지 살펴보라. 

 

🖊️ My review

• From the example below, I better understood the importance of using searchable and meaningful variable names, something I hadn’t paid much attention to in the past. I used to think naming variables with overly long names was unnecessary, but now I understand why even a single variable should be thoughtfully named.

 

 

🔍 Remaining questions

• polymorphic method(다형 메서드)
• noise word(불용어)

 

---

🔗 Additional Resources

• Clean Code concepts adapted for JavaScript
• Clean Code concepts adapted for Python

 

🔗 Reference

• What Is Clean Code 🔗 Naming Conventions — Part 2