[Cocoa] 코코아의 이름 규칙

코코아 프레임워크에서 이름 짓는 규칙에 익숙해지는 것은 단순히 코드의 가독성을 높일 뿐만아니라 부분적으로 키-밸류 코딩의 규칙을 따르는 것과도 관련이 있다. 애플의 이름 짓기 규칙은 특히나 약어를 거의 사용하지 않고 단어나 문장을 통째로 쓰는 경향이 있는데 이러면 메소드나 변수의 이름이 길어질 수는 있지만 그 의미를 명확히 이해할 수 있을 뿐만아니라, Xcode의 멋진 자동완성기능이 있어 그리 많은 타이핑이 필요하지도 않다. 이름 짓기가 잘 된 소스는 나중에 본인이 재사용할 때도 매우 명확하고 쉽게 접근할 수 있으며, 그 자체로 소스에 대한 주석이 될 수도 있다.

이름을 정할 때의 규칙 일반

  1. 간결하되 명확성을 해치지 않아야 한다.
  2. 군더더기를 빼라. 예를 들어 my나 object와 같은 접두어는 불필요하다.
  3. 축약형을 쓰지 마라. 축약할 때는 쉽지만 원래 의미는 나중에 아무도 알아보지 못한다.
  4. 이중적인 의미의 단어를 피하라. 예를 들어 displayText는 문자를 표시하는 메소드인가, 그냥 표시되는 텍스트의 이름을 나타내는 변수명인가?
  5. 일관성은 중요하다. 서로 다른 클래스에서 같은 이름의 메소드를 만들었다면, 이들 메소드는 같은 기능을 수행해야 한다.
  6. 접두어를 사용하는 것은 추천할만하다. 대부분의 파운데이션 클래스나 함수는 NS로 시작한다. (이는 NextSTEP에서 왔다는 의미이다.) 또한 아이폰 개발에 사용되는 UIKit에서는 UI로 시작하는 클래스들이 있다. 비슷한 기능을 하는 객체가 접두어를 통해 쓰임새나 출신을 파악할 수 있다.
  7. 클래스 이름에는 연관되는 명사가 있어야 한다. 또한 이들과 관련된 이름은 클래스 이름과 닮으면 된다. 예를 들어 UITableViewCell 은 클래스이고, 셀의 스타일을 지정하는 상수는 UITableViewCellStyleDefault 와 같은 식으로 정의되어 있다.
  8. 카테고리 이름은 클래스+카테고리 로 표현한다. 예를 들면 NSString+HTMLFormatting 과 같은 식이다. 여기서 HTML은 축약어로 들어갔지만, HTML은 널리 사용되고 있기에 허용할 수 있다. URL도 같은 맥락에서 허용한다.
  9. 델리게이트나 데이터소스 프로토콜은 이름이 곧 설명이다. UITableViewDataSource, UITableViewDelegate를 보라.
  10. 그외 프로토콜 이름은 형용사를 쓸 수 있다. 예를 들어 NSCoding 프로토콜은 NSCoder와 NSDecoder 의 두 클래스와 관련이 있음을 알 수 있다.

메소드 이름들

  1. 메소드 이름은 소문자로 시작하고, 단어 단위로 대문자를 첫 글자로 쓴다. 축약어를 쓰는 것은 명확하지 않으므로 권장하지 않는다. 또한 메소드 이름은 접두어를 쓰지 않는다.
  2. 메소드 이름을 언더스코어를 시작하는 것은 가능하나, 애플은 이를 private method로 간주하게 될 것이다.
  3. 속성을 리턴하는 메소드이름은 그 속성과 같은 이름을 쓴다. get-, calculate-와 같은 접두어를 사용하지 않는다. 이는 키-밸류 코딩 규칙과도 관련이 있으므로 중요하다.
  4. 파라미터의 이름은 그 파라미터를 설명하는 이름을 쓴다.
  5. 동사를 형용사처럼 만들지 않는다. calculationPerformed 보다는 performsCalculation이라고 한다.

델리게이트와 데이터 소스

  1. 첫번째 인자는 이 메소드를 호출하는 객체의 이름이다. 예를 들어 테이블 뷰의 데이터 소스에서 -(NSInteger)tableView:(UITableView*) numberOfRows… 와 같다. 왜냐하면 델리게이트나 데이터 소스가 되는 객체는 동시에 여러 객체의 델리게이트나, 데이터소스가 될 수 있기 때문이다.
  2. 델리게이트 메소드 이름에는 did나 will이 종종 들어갈 수 있다. 이는 어떤 작업 이전에 호출되는지, 이벤트가 일어난 이후에 호출되는지를 명시적으로 드러내는 좋은 방법이다.
  3. 델리게이트에게 어떤 ‘허가’를 요청하는 메소드는 -(BOOL)shouldCloseWindow…와 같이 should로 시작한다.

기타

  1. 상수값을 사용하는 경우 정수보다는 열거형을 선언하여 단어로 인식할 수 있도록 하라.UITableViewCellStyleDefault는 그냥 0일 뿐이지만, 이름이 붙어 훨씬 명확해진다.
  2. 전처리기가 처리하는 이름은 전체를 대문자로 사용하고 공백을 언더스코어로 대치한다. LIKE_THIS, DEFAULT_NAME_VALUE 등이 이러한 예다.
  3. 오류 이름은 접두어+고유이름+Exception으로 붙인다. NSIllegalSelectorException 이나 NSRangeException 등이 이런 이름이다.