Clean Code

Clean Code

# 클린 코드를 작성해야 하는 이유는?

• 협업 시 혹은 나중에 코드를 다시 볼 때 가독성과 이해도를 높이기 위해서 중요
  
  

# 클린 코드를 작성하는 10가지 원칙은?

1. 계획을 세우고 코딩하기
2. 페이지의 구조를 코드로 시각화하기
3. 올바른 인덴트 사용하기
4. 주석으로 적절히 설명하기
5. 과도한 주석 사용 지양하기
6. 지나치게 긴 함수 지양하기
7. 네이밍 컨벤션에 따라 함수명과 변수명 정하기
8. 코드를 수정할 때에도 이상의 원칙들을 지키기
9. 서로 다른 언어를 섞어서 이용하지 않기
10. 임포트를 압축하기

# 좋은 주석과 나쁜 주석의 차이는?

• 코드는 코드 자체로 스스로의 작동 방식을 설명할 수 있어야 하며, 이것이 어려울 때 주석의 도입이 필요
• 좋은 주석은 코드 자체만으로 설명하기 어려운 사항(eg. 작동 원리, 왜 특정 알고리즘을 선택했는지, 코드 변경 이유 등등)을 설명함