Clean code(02)

CLEAN CODE

우리는 작명가다.
클래스, 메소드, 함수, 변수 이름을 매일매일 작명한다.

시인이 되지마라
함축성은 상상력을 자극하지만
코드는 의도를 분명하게 보여주는
설명문이여야 한다.
int d; // 경과 시간
VS
intelapsedTimeInDays;
intdaySinceCreation;
intdaySinceModification;
intfileAgeInDays;

EX)
public List<int[]> getThem()
{
List<int[]> list1 = new ArrayList<int[]>();
for( int[] x : theList )
if( x[0] == 4 )
list1.add(x);
return list1;
}
theList
theList의 0번째 값
4는
list1
?

개선)
public List<int[]> getFlaggedCells()
{
List<int[]> flaggedCells = new ArrayList<int[]>();
for( int[] cell : gameBoard )
if( cell[STATUS_VALUE] == FLAGGED )
flaggedCells.add(cell);
return flaggedCells;
}
cell[STATUS_VALUE] == FLAGGED는 잠정적인 중복의 우려가 있음.
멤버함수로 수정하는 것이 좋음.

HP?
hypotenuse, health point, Hewlett-Packard어떤 의미?
일관성이 떨어지는 표기법
l, 1, O, 0 <- 좋은 폰트를 선택하라.
그릇된 정보를 제공하자 마라.

컴파일러, 인터프리터를 위한 작명은 피하라!
EX)
publicstatic void copyChars( char a1[], char a2[] )
{
for( int I = 0; I < a1.length; ++I )
{
a2[i] = a1[i];
}
}
코드 본문을 보기 전까지 어떤 인자가 복사 원본이고 어떤 인자가 복사 대상인지 모름.

다음 의도를 구분할 수 있는가?
moneyAmountvsmoney
customerInfovscustomer
accountDatavsaccount
theMessagevsmessage
여러분 자신과 동료를 위해서 의미 있게 구분하라.

프로그래밍은 커뮤니케이션이다.
발음하기 쉬운 이름을 사용하라.
Class DtaRcrd102
{
private Date genymdhms;
private Date modymdhms;
private final String pszgint = “102”;
/* … */
}

vs
class Customer
{
private Date generationTimeStamp;
private Date modificationTimeStamp;
private final String recordId = “102”;
/* … */
}
어떤 코드로 대화를 하는 것이 편할까?

정보가 많을 수록 검색양은 줄어든다.
EX)MAX_CLASSES_PER_STUDENT vs 7 ?
변수나 상수의 가시성의 범위가 넓을 수록
이름의 길이도 길어지는 것이 좋다.
검색하기쉬운 이름을 사용하라!

인코딩은디코딩 규칙을 알아야 한다.
코드를 읽는 사람에게 추가적인 부담을 주지말자.
헝가리언 표기법
멤버 변수 접두어
인터페이스 클래스와 구현 클래스
를구분하기 위한 접두어를사용하지 말자.

명료함은 최고의 덕목이다.
남들이 쉽게 이해할 수 있는 코드를 작성하라.

클래스 이름은
명사, 명사구가 좋다.
Good Ex) Customer, WikiPage, Account, AddressParser
Bad Ex) Manager, Processor, Data, Info
동사는 사용하지 않는다.

메소드 이름은
동사, 동사구가 적합하다.
EX) postPayment, deletePage, save
접근자, 변경자, 조건자는
접두어get, set, is를 붙인다.
중복 정의 생성자는 정적 팩토리메소드를 사용하고,
인수를 설명하는 이름을 사용한다.
EX) Complex fulcrumPoint = complex.FromRealNumber(23.0);

기발한 이름을 피하라.
구어체나 속어를 사용하지 마라.
특정 그룹에서 통용되는 어휘는 의도가 명확하지 않다.

추상적인 개념과 단어가 1 : 1 대응이 되도록 한다.
EX) controller, manager, driver
의도가 차이가 무엇인가?
말장난을 하지마라
때론 일관성보다는 맥락이 중요하다.
코드는논문 모델 < 잡지 모델이 좋다.

코드를 읽는 사람도 프로그래머이다.
Domain영역보다 해법 영역의 이름을 사용하라.
EX) AccountVisitor, JobQueue
적절한 해법 영역의 단어가 없다면
Domain영역에서 이름을 가져오라.

이름이 충분한 의미를 가지지 못한다면,
클래스, 함수, 이름 공간에 넣어 맥락을 부여한다.
모든 방법이 실패하면,
접두어를 붙인다.
과유불급이다.
불필요한 맥락을 없애라!

좋은 이름을 선택하려면
설명하는 능력이 있어야 하고
문화적인 배경이 같아야 한다.
지속적으로이름을 개선하라!
개발자의 반대,
관리자의 질책을 두려워 마라.
코드를 개선하려는 노력을 중단해서는 안 된다.

Clean code(02)

by 규열 김 on Jul 18, 2010

Accessibility

Categories

Upload Details

Usage Rights

1 Embed 1

Statistics

Clean code(02) Presentation Transcript