로버트 C. 마틴 저자 - 클린코드

✅ 클린 코드 원칙

1️⃣ 의미 있는 이름을 사용하라

• 변수명, 함수명, 클래스명은 역할이 명확해야 한다.
• getData() ❌ → fetchUserProfile() ✅
• temp 같은 모호한 이름 대신 userAge처럼 구체적인 이름을 사용하라.
• 불필요한 축약어는 피하라. (usrNm ❌ → userName ✅)

2️⃣ 함수는 한 가지 역할만 수행하라

• 함수가 여러 가지 일을 하면 이해하기 어렵고 유지보수가 힘들다.

• 한 가지 역할만 수행하도록 함수를 작게 나누어라.

• 예:

  python
  복사편집
  # 나쁜 예: 여러 작업을 수행하는 함수
  def processOrder():
      validateOrder()
      calculateDiscount()
      updateInventory()
      sendEmailConfirmation()
  
  

  python
  복사편집
  # 좋은 예: 역할별로 함수를 분리
  def processOrder():
      validateOrder()
      applyDiscount()
      updateInventory()
      sendConfirmationEmail()
  
  

3️⃣ 가독성을 높여라

• 적절한 공백과 줄바꿈을 활용하여 코드 흐름을 명확하게 하라.
• 너무 긴 줄은 줄여서 가독성을 높이자. (보통 80~120자 권장)
• 관련 있는 코드는 서로 가깝게 배치하라.

4️⃣ 주석을 최소화하라 (Self-Documenting Code)

• 코드가 주석 없이도 이해될 수 있도록 작성하라.

• "왜 이렇게 했는가?"를 설명하는 주석은 필요하지만, "무엇을 하는가?"를 설명하는 주석은 피하라.

• 나쁜 예 ❌

  python
  복사편집
  # 사용자 리스트를 반복하며 각 사용자에게 이메일을 보냄
  for user in users:
      send_email(user)
  
  

  좋은 예 ✅ (주석 없이도 코드만으로 충분히 이해 가능)

  python
  복사편집
  for user in users:
      sendWelcomeEmail(user)