[Effective Objective-C] #19 명확하고 일관된 작명법을 사용하라

[Effective Objective-C] #19 명확하고 일관된 작명법을 사용하라

출처 : Effective Objective-C

-

오브젝티브-C 의 이름 짓는 법은 좀 더 장황한 이름을 사용하기 때문에 훨씬 명확하다.

메서드와 변수 이름에 첫 문자를 소문자로 쓰는 카멜 표기법을 사용하고,

클래스 이름은 항상 첫 문자가 대문자인 카멜 표기법을 사용한다. 

이름에는 항상 두세 문자의 접두어를 사용한다.

메서드 이름 짓기

-

긴 메서드 이름을 사용하는 것을 두려워하지 말라.

메서드 이름이 메서드가 하는 일을 정확히 표현할 만큼만 길게 만들라.

그러나 극도로 긴 이름을 쓰지는 말아야 한다.

메서드 이름은 간결하고 정확해야 한다.

-

NSString 클래스는 좋은 작명 관례 지침을 다르는 최고의 예다.

-

다음 몇 가지 법칙은 좋은 메서드 이름을 지을 때 도움이 된다.

     메서드가 새롭게 생성된 값을 반환한다면 localizedString 과 같이 맨 앞에 수식어가 있는 것을 제외하고,

     메서드의 첫 번재 단어는 메서드가 반환하는 타입이 되어야 한다.

     파라미터는 파라미터 타입을 나타내는 명사 바로 전에 위치해야 한다.

     객체에 액션을 실행하는 메서드는, 메서드가 액션을 실행하기 위해 파라미터가 필요하다면 명사(또는 명사들)

     뒤에 따르는 동사를 포함해야 한다.

     str 같은 약어 사용은 자제하라.

     대신 string 같이 전체 이름을 사용하라.

     불린형 프로퍼티는 is 접두어를 사용하라.

     불린형을 반환하지만 프로퍼티가 아니라면 has 나 is 접두어를 붙이라.

     C 스타일 배열을 채우는 것 같이 외부 파라미터를 통해 값을 반환하는 메서드를 위해 get 접두어를 아껴두라.

클래스와 프로토콜 이름 짓기

-

클래스나 프로토콜의 이름은 네임스페이스 충돌을 피하기 위해 접두어가 필요하다.

-

UIView 의 하위 클래스인 커스텀 뷰를 만든다면 클래스 이름은 View 로 끝나야 한다.

비슷하게 여러분의 델리게이트 프로토콜을 만든다면 이름 마지막에 Delegate 를 붙임으로써 그 클래스가 델리게이트라는 것을 알릴 수 있어야 한다.

이런 이름 구조를 따르면 나중에 코드를 봤을 때나 다른 사람이 여러분의 코드를 봤을 때 쉽게 이해할 수 있다.

기억할 점

잘 맞고 올바르다고 느낄 수 있는 인터페이스를 생성하기 위해 오브젝티브-C 의 표준 작명 관례를 따르라.

메서드 이름은 간결하지만 정확하고, 문장처럼 왼쪽에서 오른쪽으로 읽을 수 있게 만들라.

타입 축약을 이용해 메서드 이름을 짓지 말라.

가장 중요한 점은 메서드 이름을 여러분의 코드 내에서나, 아니면 다른 것과 함께 사용할 때나 항상 일관되게 짓는 것이다.

delegate, delegate 접미어, get 접두어, has 접두어, is 접두어, localizedstring, naming convention, NSString, [Effective Objective-C] #19 명확하고 일관된 작명법을 사용하라, 간결 정확, 긴 이름 메서드, 네이밍 컨벤션, 네임스페이스 충돌, 델리게이트, 동사 포함, 메서드 이름 짓기, 명확, 반환 타입, 불린형, 수식어, 액션 메서드, 약어 사용 자제, 예, 왼쪽 오른쪽, 일관, 작명법, 장황한 이름, 접두어, 카멜 표기법, 클래스와 프로토콜 이름 짓기, 타입 축약, 파라미터, 표준 작명 관례, 프로퍼티