문법과 코딩 컨벤션

학습 내용

• 언어의 문법과 코딩 컨벤션, 그리고 디자인 패턴의 중요성에 관해 비유를 통해 배웠고 이해했다. 글로 먹고 사는 사람에게 맞춤법이 중요하듯, 코드로 먹고 살 예정인 개발자에게 상술한 사항이 얼마나 중요한지 체감할 수 있었다.
• 또한 동료 간 코드 리뷰할 때의 예절에 대해 배웠고 실제로 파트너를 정해 과제 코드에 대해 리뷰하는 시간을 가졌다.

문제점 / 고민한 점

• 클래스와 인스턴스의 변수와 함수의 이름에 대해 고민해보았다. 기존에 나는 변수나 함수가 어떤 역할을 하는지에 집중해서 네이밍을 하곤 했다. 하지만 변수는 명사, 함수는 동사를 사용하는 것이 좋다는 아이디어를 얻었다. 비록 해당 시범은 코드 리뷰할 때 하지 말아야 할 것에 대한 내용이었지만, 네이밍에 대한 힌트도 얻을 수 있었다.

해결 방법

• 변수는 명사, 함수는 동사로 이름붙여야 한다는 것에 공감했다. 이것이 변수일지 함수일지 애써 생각하지 않고도, 코드를 읽어 보면 자연스럽게 파악할 수 있다고 느꼈기 때문이다.
• 코드 리뷰 실습을 진행하는 과정에서, 이전에 내가 작성한 코드를 이를 이용해 개선할 수 있다고 생각했다.

class BusinessCard {
    
    // 자세한 함수 내용은 생략 

    func runProgram() { }
    
    func addCard() { }

    func cardList() { }

    func searchCard() { }
}

• 이전 코드에 이렇게 네 가지 함수를 작성했는데, 이 중 cardList() 함수만 명사의 형태로 되어 있다. 이 함수를 showCardList(), listUpCards() 와 같이 바꿔주면, 함수가 어떤 기능을 하는지 이름에서 잘 드러나면서도 또한 한 눈에 알아볼 수 있게끔 작성할 수 있다.

별도로 기록해 두었던 내용을 옮겨 적습니다.