CS - Software Engineering - 클린 코드

클린코드

 

• 코드를 작성하는 의도와 목적이 명확한 코드
• 다른 사람이 읽기 쉬운 코드
• 가독성이 좋은 코드

 

클린코드를 만들기 위한 규칙

 

1. 네이밍 (Naming)

 

변수, 클래스, 메소드에 의도가 분명한 이름을 사용한다.

 

int date;

function isAlpha();

...

 

이름만 보고도 어떤 변수인지, 메소드인지 파악 가능한 이름 사용

 

 

2. 주석달기

 

• 반드시 주석을 달아야 할 이유가 있는 경우에만 작성
• 코드 내용 파악이 쉬운 경우 주석 달지 말 것
• 설명을 위한 설명은 금지

 

 

3. 꾸미기 (Aesthetics)

 

코드를 보기좋게 배치하고 꾸미기. 보기 좋은 코드가 읽기도 쉽다.

 

• 규칙적인 들여쓰기와 줄바꿈 사용
• 일관성있고 간결한 패턴으로 줄바꿈
• 메소드로 중복 코드 제거

 

4. 흐름제어 

 

흐름제어문 (if, while 등등)

 

• 왼쪽에는 변수를, 오른쪽에는 상수를 두고 비교

if (length >= 10) 

if (number > 100)

 

• 부정이 아닌 긍정을 다루기

if (a == b) { // a != b 대신 a == b

} else {

}

 

 

5. 착한 함수 (Function)

 

• 함수는 가급적 작게
• 1 함수 = 1 기능