TIP : Objective C Naming style.

Ch 01. 기본 명명 관례#

모든 프로그래밍 언어는 만들어진 유래나 용도에 따라서 고유의 전통, 관례, 코딩 스타일을 가진다. 이 중에서도 클래스나 변수의 이름 짓기에 관한 것이 명명법(Naming)이다. Objective-C도 C/C++이나 Java와 구별되는 관례와 스타일이 있다. 여기서는 파일 이름, 클래스, 카테고리, 프로토콜, 메소드와 변수 이름을 짓는 기본 관례에 대해 설명한다.

1. 소스 파일 이름#

• .h 파일
  클래스, 카테고리와 프로토콜 선언을 위한 헤더 파일
  ex) MyClass.h
• .m 파일
  C와 Objective-C 소스 코드 파일 이름
  보통 인터페이스나 카테고리의 구현을 담는다.
  ex) MyClass.m
• .mm 파일
  C, Objective-C와 함께 C++ 코드가 포함될 수 있다. Objective-C에서 실제로 C++ 코드를 호출하거나 기능을 사용할 때만 이 확장자를 사용한다.
• 파일명은 대문자로 시작
  클래스, 카테고리와 프로토콜 이름은 대문자로 시작하며 주요한 클래스나 카테고리 이름과 파일 이름은 일치해야 한다.
  ex) MyClass
  => MyClass.h, MyClass.m
• 프로토콜 이름
  클래스 이름이나 카테고리 이름과 겹칠 수 있다.
• 카테고리 이름
  카테고리 이름은 다른 클래스의 카테고리 이름과 겹칠 수 있다. 카테고리를 별도로 저장할 때는 확장 대상인 클래스 이름을 앞에 붙여주는 것이 좋다.
  ex) MyClass의 NewCategory
  => MyClass_NewCategory.h
• 메소드 이름은 소문자로 시작
  메소드 이름은 관례상 소문자로 시작한다
  ex) doSomething
• '_' 로 시작되는 메소드 이름
  이런 유형의 변수는 애플사를 위해서 예약되므로 사용할 수 없다.

2. 변수 이름#

• '_' 나 영문자로 시작
  변수 이름은 숫자나 특수 문자로 시작할 수 없다. 덧붙여, '__' (더블 언더스코어)로 시작하는 경우는 내부 용도로 사용하는 경우가 많아서 피하는 것이 좋다.
  ex) myVariable, __reservedVariable__
• 예약어(keyword) 사용 불가
  컴파일러에서 사용하는 예약어(keyword, reserved word)는 변수 이름으로 사용할 수 없다. 예를 들어 for, while과 같은 것은 Objective-C 문법을 이루는 예약어이므로 사용할 수 없다.
• 소문자로 시작
  변수 이름은 관례상 소문자로 시작한다.

3. 지역 변수 이름#

일반적으로 지역 변수(local variable) 이름은 클래스나 메소드의 명명 규칙을 따를 필요가 없다. 만약, 클래스나 객체의 변수와 구별하는 것이 필요하다면 소문자와 '_' 만을 사용하는 것이 좋다. 또한, 긴 메소드가 아니라면 약자를 사용하는 것도 좋은데 좁은 범위에서만 사용되기 때문에 문제가 되지 않기 때문이다. 덧붙여 i, j, k나 x, y, z와 같이 관습적으로 사용되는 이름도 있다.

int my_local_var;
int count;  
int i, j, k;  // counter
float x, y, z;  // coordinate

4. 약어의 사용#

만약 프로젝트 공통의 약어집이 있다면 코딩에서도 약어를 사용한다고 해도 의미의 혼동 없이 사용할 수 있다. 큰 프로젝트라면 공통의 용어집을 만들게 되는데 약어도 함께 정리하면 좋다. 예를 들어 다음과 같이 약어를 정의했다면 프로그램뿐만 아니라 DB 설계 등 여러 용도로 사용할 수 있다.

(단어)  - (의미) - (약어)
Customer - 고객   - Cstm
Identity - 아이디 - Id
Address  - 주소   - Addr

또는 다음과 같이 널리 사용되는 약어들은 의미가 명확하므로 풀어쓸 필요가 없다.

HTTP, FTP, HTTPS, 
JPG, TIFF, PNG, ... 
URL, XML, PDF, ...
ASCII, UTF8, EUC_KR, ...

Ch 02. 코코아 코딩 스타일#

1. 사상#

코코아(Cocoa) 개발 환경에서는 다소 길더라도 명확하고 모호하지 않은 이름을 권장한다. 이는 C/C++ 프로그램에서 약어를 선호하는 분위기와는 차이가 있다. 긴 이름은 입력을 다소 더디게 할 수 있으나 의미와 용도를 명확하게 전달할 수 있어서 대규모의 프로젝트에서 잠재적인 버그를 줄이는데 도움을 준다. 이러한 사항은 현재 제공되는 Objectivc-C 기반의 많은 프레임워크에도 적용되어 있어 그 예는 쉽게 접할 수 있다.

2. 클래스 이름#

클래스 이름은 항상 대문자로 시작한다. 덧붙여 Objective-C는 클래스를 큰 단위로 구별할 수 있는 namespace를 지원하지 않는다. 따라서, 모든 클래스의 이름은 적역적(Global)이며 프로그램에 하나밖에 없이 유일(unique)해야 하고 다른 것과 겹쳐서는 안 된다. 이 때문에 코코아 프로그래밍에서는 프레임워크별로 고유의 접두어(prefix)를 붙여서 클래스나 메소드 등을 구별한다. 다음은 코코아에서 사용되는 몇몇 접두어와 의미이다.

• NS (Foundation, Cocoa Foundation)
  코코아 파운데이션 클래스의 접두어. 과거 NeXTstep의 개발에서부터 사용된 약자라고 한다.
• UI (User Interface)
  IPhone UIKit 프레임워크의 접두어. User Interface의 약자로 생각된다.
• CF (Core Foundation)
  접두어는 대부분 C API로 저수준의 함수를 감싸는 것들이다.

만약 자신만의 커스텀 라이브러리나 클래스를 생성한다면 기존의 프레임워크와 겹치지 않는 접두어를 하나 정해서 적용하면 된다. 예를 들어 회사 이름이 'Korean Company' 라면 접두어는 'KC' 가 될 것이고 'KCCompanyClass', 'KCGreetingProtocol' 와 같은 이름을 사용할 수 있다.

KCCompanyClass
KCGreetingProtocol
KCCompanyClass_Extension

3. 변수 이름#

변수 이름은 소문자로 시작하며 의미가 앞에 나온다. 덧붙여, 쉽게 타입을 추측할 수 있는 기본형, NSString, NSArray 등의 변수에는 변수 이름에 타입 정보가 꼭 포함될 필요가 없다.

NSString *companyName;
NSArray *memberList;
int memberCount;
BOOL isActive;

변수의 데이터 타입 정보가 중요한 경우에는 다음과 같이 끝에 타입을 추측할 수 있는 정보를 추가한다. 클래스에 하나밖에 없거나 해당 타입의 변수들 중에 가장 중심이 되어 자주 사용하는 것은 단순히 클래스 이름을 소문자로 변환하여 쓸 수도 있다.

UILabel *nameLabel;
UIWebView *contentWebView;
UIImage *productImage;

//클래스당 하나, 또는 주요 변수
UIView *view;  

4. 상수와 Enum값 이름#

기존 C 언어의 관례라면 상수는 어떻게 어디서 선언하든지 대문자를 사용한다. 단어 간의 구분은 '_' 로 해두면 좋다. 변수 이름과 같이 길고 명확한 이름을 권장한다.

#define MAX_MEMBER 30
static const float DEFAULT_VIEW_WIDTH = 480.0f;

Objective-C에서는 상수라고 해서 반드시 모두 대문자를 쓰는 것을 권장하지는 않는다. Class와 같이 대문자로 시작되는 이름을 사용하는 것이 더 일반적이다.
몇 가지 형식이 있는데 다음은 데이터 형 다음에 상수의 의미를 더하는 형식이다.

[(Prefix)+DataType+(값의 의미)]

// DataType + (값의 의미)
const CGPoint CGPointZero;
const CGRect CGRectZero;
const CGSize CGSizeZero;

보다 읽기 쉬운 형식은 다음처럼 접두어와 데이터 형 사이에 의미가 들어가는 것이다.

[(Prefix)+(값의 의미)+(데이터 타입)]

// (값의 의미) + DataType
enum {
   NSASCIIStringEncoding = 1,
   NSNEXTSTEPStringEncoding = 2,
   NSJapaneseEUCStringEncoding = 3,
   NSUTF8StringEncoding = 4,
   NSISOLatin1StringEncoding = 5,
   ...
};

5. 메소드 이름#

Objective-C의 메소드의 이름(Method Signature Keywords)에 인자(Parameter) 하나마다 구분자가 들어간다. C++이나 Java에서 메소드를 호출할 때 모든 인자가 괄호로 쌓여서 ',' 로 구별되는 것과는 다른 Objective-C의 고유한 문법이다. 이런 스타일의 문법은 다소 번거롭기는 하지만 이름을 잘 지어두면 메소드의 용도 뿐 아니라 전달해야 할 인자가 어떤 것인지 쉽게 이해할 수 있다. 다음의 예를 보자.

// Objective-C style
[myArray addObject:object atIndex:index];

// C style
myArray.addObjectAtIndex(object, index);

따라서 인자를 놓는 순서와 함께 이름을 짓는 것도 실제 사용하는 입장에서 어떻게 사용할지를 고려하지 않으면 안된다. 보통 대상을 앞에두고 방법이나 옵션을 나중에 두는 것이 무난하다. 덧붙여, 같은 이름의 메소드가 여러 개가 있는 경우 인자의 순서가 되도록 바뀌지 않는 것이 좋다.

// 주된 대상을 앞에, 옵션을 뒤에
[@"MyString" writeToFile:file atomically:YES]

// 옵션 추가하기
[@"MyString" writeToFile:file atomically:YES encoding:... error:error];

6. Getter와 Setter#

객체의 속성을 조회하는 메소드는 getXXX 형식을 사용하기 때문에 보통 Getter 메소드라고도 한다. 마찬가지로 속성값을 설정하는 메소드는 setXXX 형식이기 때문에 Setter 메소드로 부른다. Objective-C에서는 특별한 경우가 아니면 getter 메소드 이름을 'get' 으로 시작하는 것을 권장하지 않는다. 단순히 변수 이름과 같은 것을 사용해도 좋다. 이는 변수와 메소드를 특별히 구별할 필요가 없는 객체 지향적인 관점에서도 타당하다. 'get' 을 추가하는 때도 있는데 단순히 값을 반환하는 것이 아니라 내부에 추가적인 작업이나 부작용(side-effect)이 동반되는 경우이다. 반면에 setter 메소드는 일반적인 setXXX:(Type) 형식을 사용한다.

//get property
[myBoss firstName];
[myBoss lastName];
[myBoss age];

//추가적인 작업, 부작용이 동반되는 경우 
[myBoss getFullName]; 

// set property
[myBoss setFirstName:@"new Name"];

BOOL형 변수나 값에 대한 getter나 setter의 형식은 조금 달라진다. 변수 이름이 'isActive' 라면 getter아 setter는 각각 'isActive', 'setActive' 가 된다.

BOOL isHidden;
BOOL isEditable;

[myObject isHidden];
[myObject setHidden: YES];
[myObject isEditable];
[myObject setEditable: NO];

7. 반환값이 있는 메소드의 이름#

Objective-C에서는 Getter 메소드가 'get'으로 시작하는 것을 권장하지 않는 것처럼 반환 값이 있는 메소드의 경우도 동사로 시작하는 것을 권장하지 않는다. 다음의 예를 보자.

// 3번 index에 저장된 객체 반환
[myArray objectAtIndex:3];

// key에 매핑된 객체 반환
[dictionary objectForKey:key]

반환형이 있는 메소드는 다음과 같은 형식을 사용한다.

[type+Condition, Method+Input]

[NsString stringWithFormat:...];
[str rangeOfString:scan_str];

[NSSArray arrayWithObjects:...];
[arry indexOfObject:obj];

8. 이벤트와 관련된 이름#

이벤트(Event)에 관한 메소드나 변수는 조금 다른 형식의 이름이 사용된다. 이벤트가 발생하는 시점에 관한 조동사인 will, did가 Action 이름과 함께 사용된다. 'will' 은 동작이 일어나기 직전에 발생하거나 호출되는 것을 의미하고 'did' 는 동작이 일어난 다음의 시점을 뜻한다.

다음의 예를 보자. 객체나 상수인 경우 '접두어+(Will/Did)+Action' 형식이다.

// 상수
// (Will/Did)+Action+Type
NSTaskDidTerminateNotification
NSWindowWillMoveNotification

위와 유사하게 이벤트와 관련된 메소드는 '(will/did) + Action' 의 형식을 사용한다.

// 메소드 이름
// (Will/Did)+Action+Target
[view didAddSubview];
[view willAddSubview];

출처 : http://blessedsoft.org/wiki/Wiki.jsp?page=GuruBook.ObjectiveCES.codingconv

정리가 너무 잘되있어 퍼왔다.

함수명만 잘 정해놔도 따로 주석이 필요가 없더라.

가독성, 일관성 유지하는게 관건.

나같은 경우엔 거의 혼자만 아이폰 프로젝트 진행하다보니 일관성있게는 짜는데.. 다른사람들보기엔 어떨지 몰것넹...