본문 바로가기

플밍 is 뭔들/Clean Code

1-3. 이름을 잘 짓는 간단한 규칙 (의미 있게 구분하기)

동일한 범위 안에 다른 두 개념에 같은 이름을 사용하지 말아라. 읽는 사람이 차이를 알도록 이름을 지어라.

다음과 같이 이름을 짓는 것은 피하라.

getActiveAccount();
getActiveAccounts();
getActiveAccountInfo();

 

연속된 숫자를 붙이지 말아라.
연속적인 숫자를 덧붙인 이름(a1,a2, ...,aN)은 아무런 정보 제공도 안하고 저자의 의도가 전혀 드러나지 않는다.

public static void copyChars(char a1[], char a2[]){
	for (int i = 0 ; i < a1.length ; i ++){
		a2[i] = a1[i];
	}
}

 

불용어(의미가 없는 단어나 조사)를 추가하지 말아라. 불용어를 추가한 이름 역시 아무런 정보를 제공하지 않는다.

NameString -> name
ProductInfo, PublicData -> Product

 

함수 인수 이름으로 source(출처)와 destination(목적지)를 사용한다면 코드가 읽기 더 쉬워진다.

//인수(Argument), 인자(Parameter)
   
function add(num1, num2){
	return num1 + num2;
}
//num1, num2는 인자(Parameter), 함수 정의에서 사용되는 변수를 의미
   
 ////////////////////////////////////////////////////////////////
   
add(3,4);
//3,4의 값이 인수(Argument),함수를 호출할 때 사용되는 값