Naming convention

In computer programming, a naming convention is a set of rules for choosing the character sequence to be used for identifiers which denote variables, types, functions, and other entities in source code and documentation.

• 식별자의 명칭이 되는 문자열을 결정하기 위한 규칙
• 목적: 가독성, 시인성, 효율성
• 프로젝트, 프로그래밍 언어, 개발도구 등에 따라 달라질 수 있음

Notation

camelCase (카멜 표기법)

첫 단어를 제외한 각 단어의 첫 글자는 대문자를 사용. (첫 단어는 소문자 사용)

Java에서 사용.

PascalCase (파스칼 표기법)

모든 단어의 첫 글자는 대문자를 사용.

Java에서 사용.

under_scores, snake_case (스네이크 표기법)

모든 글자는 소문자를 사용, 각 단어를 밑줄(_)로 구분한다.

C에서 사용한다.

strHungarianNotation (헝가리안 표기법)

타입명을 소문자로 먼저 적고, 이 후 모든 단어의 첫 글자는 대문자 사용.

Win32 API에 사용된 표기법.

kebab-case (케밥 표기법)

모든 글자는 소문자를 사용, 각 단어를 대시(-)로 구분한다.

HTML에서 사용됨.

Method Naming Convention

• [추천] Method Naming Conventions (The Java™ Tutorials > Date Time > Date-Time Overview)
• How and why to decide between naming methods with “get” and “find” prefixes
• Coding Guidelines for Cocoa - Naming Methods
• [추천] 참, 거짓을 반환 하는 함수의 네이밍 - jacking75

get{1}, set{1}

Hint: Java

Getter¹와 Setter²에서 사용한다.

to{1}

Hint: Java의 Object.toString()을 참조함.

객체 자신(this)의 자료형을 변환(Convert)할 때 사용되며, 결과(반환) 타입을 {1}에 입력.

{1}With{2}

Hint: Objective-C의 NSNumber, + numberWithInteger를 참조함.

자료형을 변환(Convert)할 때 사용되며, 원본값(파라미터)은 {2}이고 결과(반환)값은 {1}이다.

with의 "…을 써서"의미를 적용.

Example: toStringWithFormat, toIntegerWithString

from{1}To{2}

{1}(파라미터)를 사용하여 {2}(반환값)로 변환한다.

from A to B의 "어느 한 장소(A)에서 다른 장소(B)로" 의미를 적용.

at{1}

Hint: C++의 STL Container 참조.

Getter와 Setter의 혼합. C++에서는 참조형을 반환한다. 보통 파라미터로 INDEX를 사용한다.

readFrom{1}, ;writeTo{1} ³

클래스에서 사용되며, 읽기와 쓰기를 담당한다. 읽기(Read)의 경우 {1}으로 부터 획득하고, 쓰기(Write)의 경우 {1}로 입력한다.

has{1}

포함하는 것에 대한 조사를 위해 사용.

is{1}

상태(Status)에 대한 조사.

exists

Hint: Java의 Files.deleteIfExists(target);

존재여부를 확인한다.

create{1}

생성한다.

Boolean 반환 함수

• Bool 변수 이름 제대로 짓기 위한 최소한의 영어 문법 · Soojin Ro
  • Swift.org - API Design Guidelines

is 용법

is로 시작하는 변수명이 가장 흔한 케이스 아닌가 싶다. 뒤에 나오는 단어의 특징에 따라 세 가지로 나눌 수 있다.

• is + 명사
• is + 현재진행형(~ing)
• is + 형용사

is + 명사

“(무엇)인가?” 라는 뜻으로 쓰인다.

func isDescendant(of view: UIView) -> Bool //UIView: "view의 자식인가?" 

is + 현재진행형(~ing)

var isExecuting: Bool { get } //Operation: "오퍼레이션의 작업이 현재 실행 중인가?"
var isPending: Bool { get } //MSMessage: "메시지가 보내지기 전 대기 중인가?"

is + 형용사

이제부터 살짝 헷갈릴 수 있다. 형용사도 두 종류로 나뉜다.

• 단어 자체가 형용사인 것 - opaque, readable, visible 등
• 과거분사 형태 - hidden, selected, highlighted, completed 등

과거분사(past participle)는 간단히 말해 동사로 만든 형용사라고 생각하면 된다. 동사를 과거분사로 바꾸면 뜻이 여러가지로 바뀔 수 있는데, 일단 여기서는 수동태라고 생각하면 되겠다.

• hide(숨다) - hidden(숨겨진)
• select(선택하다) - selected(선택된)
• complete(완료하다) - completed(완료된) 등등.

보다시피 동사 뒤에 -ed가 붙는 형태가 가장 흔하지만, 내가 쓰려는 동사의 과거분사를 모르겠으면 사전을 찾아보자.

UIKit을 쓰다보면 정말 많이 보는 UIView의 프로퍼티들이 이런 경우다.

var isOpaque: Bool { get set }
var isSelected: Bool { get set }
var isHighlighted: Bool { get set }
var isHidden: Bool { get set } 

• isAuthorize, isHide, isFind 등등.

가령,

var isEdit: Bool //gg

edit이라는 단어가 명사로 쓰일수도 있어서 해석의 여지는 있지만 뜻이 명확하지 않아 일반적으로는 곧바로 해석하기 쉽지 않다. 😧 더 잘 할 수 있다.

아래와 같이 적절하게 바꿔주면 해석이 더 쉽고 빠르다.

var isEditable: Bool //편집할 수 있는가?
var isEditing: Bool //편집 중인가?
var canEdit: Bool //편집할 수 있는가? -> 다음 '조동사 용법' 섹션 참고

4월 11일 추가

닷넷 프레임워크에 DataRowView.IsEdit이라는 불리언 변수가 있다는 제보를 받았다. 문서를 보면 ‘row가 edit mode인지’를 나타내는 불리언인데 닷넷 개발자가 아닌 다른 개발자가 edit mode 라는 것을 모르는 상태에서 문서를 읽어보지 않고는 한번에 이해할 수 없었을 것이다. 하지만 만약 IsEdit이 닷넷 프레임워크에서 자주 쓰이는 변수명이자, edit이 edit mode를 의미한다는 것이 컨벤션이라면 괜찮을 수 있다. 변수명에 신경쓰는 이유 자체가 다른 개발자(또는 내일의 나)가 내 코드를 쉽고 빠르게 이해하게 하려는 것이기에.

조동사 용법

조동사(modal verb)는 동사를 돕는 동사란 뜻인데 can, should, will 등이 있다. 주의할 점은 조동사 + 동사원형 으로 써야한다는 것 하나 뿐이다.

• can: “~ 할 수 있는가?”
• should, will: “~ 해야 하는가?” 혹은 “~ 할 것인가?”

등등.

var canBecomeFirstResponder: Bool { get } //UIResponder: first responder가 될 수 있는가?
var shouldRefreshRefetchedObjects: Bool { get set } //NSFetchRequest: 가져온 값을 refresh 할 것인가?

has 용법

has로 시작하는 Bool 변수명은 상대적으로 빈도가 낮지만 뜻이 전혀 다르게 쓰이는 두 가지가 있어서 알아두면 유용하다.

• has + 명사
• has + 과거분사

has + 명사

has 다음 명사가 나오면 “~를 가지고 있는가?” 라는 뜻이다. has는 have의 3인칭 단수인데 3인칭 단수에 대해서는 다음 파트에서 자세히 다룬다.

var hasiCloudAccount: Bool { get } //CKUserIdentity: 관련된 iCloud 계정을 가지고 있는가?
var hasVideo: Bool { get set } //CXCallUpdate: 콜에 비디오가 포함되어 있는가?

has + 과거분사

모든 케이스를 통틀어 가장 덜 쓰이는 케이스 같으므로 만약 이해 안되더라도 넘어가도 지장 없다. 게다가 is + 과거분사와 뜻이 거의 같기 때문에 꼭 알아야할 필요도 없어보인다.

이때의 과거분사는 아까 is + 과거분사 때와는 다른 의미이다. has + 과거분사는 현재완료 의 의미를 가지는데 굳이 해석하자면 ‘과거에 완료된 것이 현재까지 유지되고 있다’는 뜻이다. 따라서 Bool 변수로 쓰이면 ‘~가 유지되고 있는가?’ 라고 해석할 수 있다.

var hasConnected: Bool { get } //CXCall: 콜이 연결되어 있는가?
var hasEnded: Bool { get } //CXCall: 콜이 끝났는가?

근데 isConnected, isEnded로 해도 의미가 비슷하다. 영어로 미묘한 느낌적인 차이가 있긴 하지만 수능을 다시 볼게 아니라면 꼭 알아야하는 건 아니라고 생각한다.

동사원형 용법

Bool 변수 짓기의 끝판왕이라는 생각에 마지막에 넣었다. 이거까지 잘 쓸 줄 알면 원어민 개발자 부러워하지 않아도 된다. (지극히 개인적인 의견)

주의할 점은 동사원형을 3인칭 단수로 써야한다는 것이다. 3인칭 단수는 보통 동사원형 뒤에 -s나 -es가 붙는 형태이다. Cocoa Touch에서 자주 쓰이는 단어들을 보면,

• supports: ~을 지원하는가?
• includes: ~을 포함하는가?
• shows: ~을 보여줄 것인가?
• allows: ~을 허용할 것인가?
• accepts: ~을 받아 주는가?
• contains: ~을 포함하고 있는가?

등이 있다. 이정도 단어들의 쓰임새만 알아도 풍부한 Bool 변수명을 짓기에 충분한 것 같다.

var supportsVideo: Bool //CXProviderConfiguration: 비디오를 지원하는가?
var includesCallsInRecents: Bool //CXProviderConfiguration
var showsBackgroundLocationIndicator: Bool //CLLocationManager
var allowsEditing: Bool //CNContactViewController: 편집을 허용하는가?
var acceptsFirstResponder: Bool //NSResponder

그 외에도 returns, preserves 등도 있었다.

var preservesSuperviewLayoutMargins: Bool //UIView
var returnsObjectsAsFaults: Bool //NSFetchRequest

하지만 3인칭 단수가 아닌 경우도 있다. 꽤나 예외적인 경우로 판단되기 때문에 이 역시 이해가 안되더라도 그냥 넘어가도 무방하다.

//Core Location의 CLRegion 
var notifyOnEntry: Bool { get set }
var notifyOnExit: Bool { get set }

유저의 기기가 해당 region을 벗어나거나 진입할 때 delegate를 통해 노티피케이션을 받을지 말지를 나타내는 Bool 값이다. 이 경우 notifies가 아닌 동사원형 그대로 쓰인 이유는 region 인스턴스가 notify를 하는 주체가 아니기 때문이다. 만약 notifies로 썼다면 region 인스턴스가 노티를 준다는 뜻인데 이는 맞지 않다. (아마도 CLLocationManager가 노티를 주지 않을까. 아무튼 region 인스턴스가 notify를 하는 주체가 아니기 때문에 3인칭 단수를 쓰지 않았다.)

3인칭 단수가 중요한 이유

코드 한 줄을 하나의 문장으로 비유하면 주어 역할을 하는 인스턴스가 3인칭 단수이기 때문에 문법적으로 꼭 써야하는 이유도 있지만, 3인칭 단수로 쓰지 않을 경우 스위프트 API 디자인 가이드와의 일관성이 깨져서 코드를 읽는 사람을 혼란에 빠뜨릴 수 있다. 가이드에 따르면 mutating 함수는 동사원형으로, nonmutating 함수는 동사 뒤에 -ed나 -ing를 붙여서 쓴다.

친숙한 예시로 Array의 sort()와 sorted()를 생각하면 된다.

mutating func sort() -> Void //in-place sort
func sorted() -> [Element] //정렬된 새 배열을 리턴

가령,

let overlaps: Bool = region1.overlaps(region2) //region1과 region2가 겹치는가?
region1.overlap(region2) //region1을 region2와 겹치는 부분으로 mutate
let region3 = region1.overlapping(region2) //region1과 region2가 겹치는 부분만 새로운 region 인스턴스로 리턴

이런 식으로 각각 Bool, mutating, nonmutating 함수의 이름을 지어줘야 가독성을 해치지 않고, 영문법적으로도 올바르고, 가이드에 충실한 네이밍을 할 수 있다.

See also

• Coding Guidelines
• Comment (computer programming)

Favorite site

• Wikipedia (en) Naming convention
• 오픈소스의 네이밍 특징들 ⁴
  • 소스코드의 (변수,함수,클래스)네이밍 데이터 분석해 보기
• 변수명을 잘 짓기 위한 몸부림

References