[클린코드] 2장 의미 있는 이름

안녕하세요 남갯입니다

오늘은 클린코드 2장 의미있는이름 에 대해 포스팅 해보려고 합니다.

2장 의미있는이름

- 의도를 분명히 밝혀라

의도가 분명하게 이름을 지으라고 말하기는 쉽다. 이 책에서는 의도가 분명한 이름이 중요하다고 강조하고 또 강조한다.

좋은 이름을 지으려면 시간이 걸리지만 그렇게 지어놓으면 후에 유지보수에서 시간을 절약할 수 있다. 그래서 우리는 이름을 주의깊게 살펴서 더 나은이름으로 개선해야한다. 그리고 그걸 읽는 나와 다른사람들도 행복해질 수 있다. 

변수나 함수 클래스의 이름은 변수(함수 or 클래스) 의 존재이유? 수행기능? 사용방법? 에 따로 주석이 필요하다면 의도를 분명하게 드러내지 못했다는 말이다. 

예들들어

 

val d = 0; // 경과시간

이름 d는 아무 의미도 드러나지 않는다. d라는 이름만 보고 day인지 delay인지 확인을 한번 더 해줘야한다.

val elapsedTimeInDays : Int = 0
val daysSinceCreation : Int = 0
val daysSinceModeification : Int = 0
val fileAgeInDays : Int = 0

위와같이 의도가 분명한 코드들은 변수명만으로 코드의 이해와 변경 의도가 분명하다.

val theList = arrayListOf<IntArray>()
val list = arrayListOf<IntArray>()
for(x in theList){
    if(x[0] == 4){
        list.add(x)
    }
}

이런 이름을 가진 리스트가 있다고 했을때 딱 변수명만으로는 무슨 동작을 하는 코드인지 알 수 없다.

• theList에 무엇이 들었고,
• 0번째값을 왜 찾아야하며,
• 값이 4는 무슨 의미인지,
• 함수가 반환하는 리스트 list는 어떻게 사용하는가?

에 대한 정보가 하나도 드러나지 않는다.

정보제공은 충분히 가능했지만 그렇지 않았다.

우리가 지뢰찾기 게임을 만든다고 가정해보자 그러면 theList가 게임판이라는 사실을 우리는 알 수 있다

theList -> gmeBoard 로 변경해보자

0번째값은 칸 사애를 의미하고 4는 깃발이 꽂힌 상태를 가리킨다.

val gameBoard = arrayListOf<IntArray>()
val STATUS_VALUE = 0
val FLAGGED = 0

fun getFlaggedCells() : List<IntArray>{
    val flaggedCells = arrayListOf<IntArray>()
    for(cell in gameBoard){
        if(cell[STATUS_VALUE] == FLAGGED){
            flaggedCells.add(cell)
        }
    }
    return flaggedCells
}

위에서 보듯이 코드의 단순성은 변하지 않는다. 하지만 코드는 더 명확해졌다 더 나아가 int 배열을 사용하는 대신 칸을 간단한 클래스로 만들어도 된다.

isFlagged라는 명시적인 함수를 사용해 FLAGGED라는 상수를 감춰도 좋겠다.

val gameBoard = arrayListOf<Cell>()
val STATUS_VALUE = 0
val FLAGGED = 0

fun getFlaggedCells(): List<Cell> {
    val flaggedCells = arrayListOf<Cell>()
    for (cell in gameBoard) {
        if (cell.isFlagged) {
            flaggedCells.add(cell)
        }
    }
    return flaggedCells
}

class Cell(val isFlagged: Boolean = false) {
}

이렇게 개선되었다.

- 그릇된 정보를 피하라

프로그래머는 코드에 그릇된 단서를 남겨서는 안된다. 또한 나름대로 널리 쓰이는 의미 있는 단어를 다른 의미로 사용해도 안된다.

예를 들어 hp,aix, sco는 변수 이름으로 적합하지 않다. 유닉스나 유닉스 변종을 가리키는 이름이기 때문이다.

여러계정을 묶을때 실제로 List가 아니면 accountList라 명명하지 않는다. 프로그래머에게 List라는 단어는 특수한 의미다.

계정을 담는 컨테이너가 실제 List가 아니라면 그릇된 정보를 제공하는 셈이다.

하나의 모듈에서

XYXControllerForEfficientHandlingOfStrings

XYXControllerForEfficientStorageOfStrings

두개의 단어는 엄청 비슷하다. 유사한 개념은 유사한 표기법을 사용한다.

또한 비슷한 개념이라 자동완성기능을 통해 두개의 후보목록으로 뜬다면 엄청나게 유용해진다.

- 의미있게 구분하라

fun copyChar(a1 : CharArray , a2 : CharArray){
    for(i in 0 until a1.size){
        a2[i] = a1[i]
    }
}

a1, a2가 아닌 source destination을 사용한다면 코드 읽기가 더 쉬워진다.

불용어를 추가한 이름 역시 아무런 정보도 제공하지 못한다. **** 

(a an the Info , Data)

Product 라는 클래스가 있다고 가정하면 다른 클래스를 ProductInfo, ProductData라고 부른다면 개념은 구분하지 않은채 이름만 달리한 경우이다.

의미가 분명하게 다르다면 사용해도 되지만 zork와 theZork라 이름지어서는 안된다.

또한 불용어는 중복이라고 한다.

variable 이라는 단어 혹은 table 등 이런 불용어를 써서 

Name과 NameString 중 Name자체가 다른 타입이 될 수 있는 가능성이 없다. 따라서 그릇된 정보를 피하라 규칙을 위한하게 된다. 

Customer 라는 클래스와 CustomerObject라는 클래스를 발견한다고 해도 차이를 느끼기 어렵다.

moneyAmount 와 money

customerInfo와 customer

accountData와 account

theMessage 와 message

두개의 구분이 안된다. 읽는 사람이 차이를 알도록 이름 지어라

class DtaRcrd102{
    private val genymdhms = Date()
    private val modymdhms = Date()
}
class Customer{
    private val generationTimestamp = Date()
    private val modificationTimeStamp = Date()
}

두개의 이름을 본다면 위에꺼에 비해 아래의 변수명이 더 명확하지 않은가?

- 검색하기 쉬운 이름을 사용하라

MAX_CLASSES_PER_STUDENT 는 grep을 이용해 찾기 쉽지만 7은 까다롭다 7이 들어가는 다른 파일도 검색되기 때문이다.

따라서 

var s = 0
var t = arrayOf(0)
for(j in 0..34){
    s += (t[j] * 4) /5
}

val realDaysPerIdealDay = 4
val WORK_DAYS_PER_WEEKS = 5
val NUMBER_OF_TASKS = 34
for(j in 0..NUMBER_OF_TASKS){
    val realTaskDays = taskEstimate[j] * realDaysPerIdealDay
    val realTaskWeeks = (realTaskDays / WORK_DAYS_PER_WEEKS)
    sum += realTaskWeeks
}

위에에서는 5로 검색해야하지만 아래에서는 WORK를 검색한다면 검색이 된다. 이렇게 쉬운 단어를 이용해 숫자가 아닌 문자를 검색하게 해야한다.

-인코딩을 피하라

• 인코딩과 헝가리안 표기법은 자제하라.

굳이 부담을 안해도 이름에 인코딩할 정보는 많다.

PhoneNumber phoneString

타입은 바뀌어도 이름은 바뀌지 않는다.

• 멤버변수 접두어

m_이라는 접두어를 붙여서 변수를 만들필요도 없다.

• --인터페이스 클래스와 구현클래스

인터페이스에는 IShapeFactory I라는 이름의 접두어를 붙이지 않고 구현클래스에 ShapeFactoryImp 나 CShapeFactory가 I를 인터페이스에 붙이는것(IShapeFactory)보다 낫다.

- 자신의 기억력을 자랑하지 마라

루프는 i,j,k 그 이외것은 사용하지 말고, Url을 r과같이 사용하지 말아라. 남들이 이해하기 쉬운 코드를 만들어라

- 클래스 이름

명사나 명사구를 이용하라

-메서드이름

동사나 동사구가 적합하다. postPayment, deletePage, save 등이 좋은 예   접근자 변경자 조건자는 get set is를 붙인다.

Complex fulCrumPoint = Complex.FromRealNumber(23.0)

Complex fulCrumPoint =  new Complex(23.0);

위의 코드가 아래의 코드보다 더 좋다.

-기발한 이름은 피하라

프로그래머가 재치를 발휘해 구어체나 속어를 사용하는데 의도를 분명하고 솔직하게 표현해야한다.

-한 개념에 한 단어를 사용하라

어떤건 DeviceManager를 쓴다던지 어떤거는 ProtocolController 라던지 Controller와 Manager라는 단어를 혼용해서 쓰는건 좋지않다.

일관성있는 단어를 사용해야한다.

- 말장난을 하지마라

한 단어를 두 가지 목적으로 사용하지 마라.  add라는 메서드가 생겼는데  

기존의 add는 덧셈을 위해 썼다고 보면 새 add메서드는 집합에 값 하나를 추가한다.

새로운것과 기존 메서드와 맥락이 다르다. 그러므로 insrert나 append 라는 이름이 적당하다. add라고 부른다면 말장난과 다름이 없다.

- 해법영역에서 가져온 이름을 사용해라

코드읽을사람도 프로그래머이다.  기술개념에는 기술이름이 가장 적합한 선택이다.

- 문제영역에서 가져온 이름을 사용하라

적절하 프로그래머 용어가 없다면 문제 영역에서 이름을 가져와야한다.

- 의미있는 맥락을 추가하라

firstName , lastName, street, houseNumber, city, state, zipcode 라는 변수가 있다면 주소라는것을 알 수 있다.

하지만 state 라는 변수 하나만 사용한다면 이게 주소의 일부라는것을 알 수 가 없다.

따라서 addrFirstName , addrLastName, addrState 라 쓰면 맥락이 분명해지고 주소라는것을 알 수 있다. 

-불필요한 맥락을 없애라

고급 휘발유 충전소라는 어플리케이션을 짤때

GSD(Gas Station Deluxe) 로 시작하면 바람직 하지 못하다.  또한 일반적으로 짧은이름이 긴이름보다 좋다. 

물론 의미가 분명한 경우에 한해서이다. 이름에 불필요한 맥락을 추가 하지 않도록 주의해야한다.

마치며

위와같이 의미있고 다른 프로그래머가 보더라도 무슨 의도의 이름인지 한눈에 드러올 수 있는 이름의 변수명을 짜도록 노력해보자