디스 프로그래머 (This Programmer)

좋은 변수이름 정하기 : 표준 접두사의 장점 본문

소프트웨어 공학/Clean Code

좋은 변수이름 정하기 : 표준 접두사의 장점

디스 프로그래머 2018. 10. 12. 23:43

이 게시물은 스티브 맥코넬이 쓴 CODE COMPLETE2에 나온 내용이며 다른 사람들에게도 변수 이름의 중요성과 그 이름을 정하는 데 도움을 주기 위해, 그리고 나 자신도 필요할 때마다 참고하기 위해 쓴다는 것을 알린다.

표준 접두사의 장점

표준 접두사는 이름 규약이 갖는 일반적인 장점을 모두 제공할 뿐만 아니라 다른 장점도 제공한다. 매우 많은 이름이 표준화되어 있기 때문에 단일 프로그램이나 클래스에서 기억해야 하는 이름이 적어진다.

 표준 접두사는 모호해지기 쉬운 이름 영역을 정확하게 만든다. min과 first, last, max사이의 정확한 구분은 특히 도움이 된다.

 표준 접두사는 이름을 더욱 간결하게 만든다. 예를 들면 단락의 수를 나타내기 위해서 totalParagraphs대신 cpa를 사용할 수 있다. 단락 배열에 대한 인덱스를 구별하기 위해서 indexParagraphs나 paragraphsIndex대신 ipa를 사용할 수 있다.

 마지막으로 표준 접두사를 이용하면 컴파일러가 검사할 수 없는 추상 데이터형을 사용할 때 타입을 정확하게 검사할 수 있다. paReformat = docReformat은 pa와 doc이 서로 다른 사용자 정의 데이터 타입이기 때문에 아마도 틀렸을 것이다.

 표준 접두사의 가장 큰 문제는 개발자가 접두사에 이어지는 변수에 의미 있는 이름을 부여하지 않을 때 발생한다. 예를 들면 ipa가 단락 배열의 인덱스를 분명하게 나타내고 있기 때문에 ipaActiveDocument와 같이 더욱 의미 있는 이름을 만들려고 하지 않는다. 가독성을 위해 이해하기 쉬운 이름을 만들어야 한다.

0 Comments
댓글쓰기 폼