Clean Code Review

Clean Code (애자일 소프트웨어 장인 정신)

 

깨끗한 코드 

• 나쁜 코드가 쌓일수록 팀 생산성은 떨어진다.
• 생산성이 떨어지면 나쁜 코드를 양산하게 된다.
• 코드는 프로그래머의 책임이다.
• 요구사항이 많고 시간이 없어도 코드는 나의 책임이다.
• 잘 짠 코드도 언제나 깨끗하게 유지해야 한다.

의미있는 이름

• 코드를 읽는 사람도 프로그래머이다.
• 말장난을 하지마라.
• 읽기 쉽고 검색하기 쉬워야 한다.
• 팀원 간 지적인 대화가 가능해야 한다.
• 클래스 이름은 명사나 명사구, 메서드는 동사나 동사구가 적합하다.

함수

• 함수는 한가지 일을 한다.
• 하나의 일을 잘해야 한다.
• 코드는 위에서 아래로 이야기처럼 읽혀야 좋다.
• 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
• 다형성을 고려하고 인수를 줄여라.
• 플래그 인수는 추하다.

주석

• 프로그래머가 주석을 유지보수 하기는 불가능에 가깝다.
• 주석은 언제나 실패를 의미한다.
• 주석은 맞는지 틀린지 확인하기 어렵다.
• 차라리 코드에 시간을 투자해라.
• 소스 코드 관리 시스템은 모든 것을 기억한다.
• 이름을 넣어 코드를 오염시킬 필요가 없다.