[Swift] 이름 짓기(Naming)

함수(func)에 대한 글을 작성했을 때 스위프트는 카멜 케이스(Camel Case) 방식으로 이름을 짓는다고 했습니다.

카멜 케이스는 이름에 맨 앞에 오는 글자를 소문자로 표기하고, 그 다음 단어부터는 첫글자를 대문자로 표기합니다.

낙타의 등에 있는 혹같다고 카멜(Camel) 표기법이라고 합니다.

내가 아닌 다른 사람이 나의 코드를 봤을 때에도 이해하기 쉬운 네이밍을 하는 것이 협업 시 굉장히 중요한 부분을 차지합니다.

---

🔸 오류가 발생되는 규칙

1. 숫자로 시작하지 않습니다.
   - 두번째 글자부터는 숫자가 와도 됩니다.
2. 띄어쓰기를 하지 않습니다.
3. 특수문자는 $, _만 사용할 수 있습니다.
   단, $는 첫글자로 사용할 수 없습니다.

---

🔸 사용자들간 약속된 규칙

1. 이름을 카멜 케이스 방식으로 짓습니다.
   ex. myName, myAge, addObserver, newPart
   단, 타입 이름은 대문자로 시작합니다. (enum, class, struct, extension 등 타입을 만들어 줄 때도 해당)
2. 열거형, 배열 등 여러개의 값이 포함되는 값일 경우 복수를 뜻하는 ~s나 list를 붙여줍니다.
3. 아래 Swift API Design Guidelines를 준수합니다.

🔸 Swift API Design Guidelines 일부 발췌

출처 : Swift API Design Guidelines 

 

1. 이해에 필요한 모든 단어를 포함합니다.
2. 불필요한 단어, 중복된 단어는 최대한 생략합니다.
3. 역할을 표현하는 이름으로 정합니다.
4. 사이드 이펙트가 있는 것의 이름은 동사로 정합니다.
5. 타입, 속성, 변수, 상수의 이름은 명사로 정합니다.
6. 능력을 설명하는 프로토콜은 ~able, ~ible 또는 ~ing 접미사를 사용하여 이름을 지정해야 합니다.
7. 팩토리 메서드(인스턴스를 생성하는 메서드)는 make로 시작합니다.
8. Initializer와 Factory Method는 영어 문장처럼 짓지 않습니다.
9. 전문용어, 약어를 되도록이면 사용하지 않습니다.

🚩 스위프트 API 디자인 가이드라인은 변경이 될 수 있으므로 원본 문서를 체크하는 것을 추천합니다.