Swift 네이밍 규칙

스위프트 상수와 변수, 함수, 클래스 이름을 지정시 규칙

• 유니코드를 포함한 어떤 문자든지 사용가능

  ( 단, 특수문자, 수학 기호, 화살표, 개인용 유니코드, 선 등 사용 할 수 없다. )

  • 단, 숫자로 시작할 수 없다.
  • 단, 공백이 포함되면 안된다.
  • 단, 해당 코드 범위 내에서 미리 사용되는 기존 이름과 동일한 이름은 사용하지 말 것

• 이름 읽었을 때 무슨 역할을 하는 건지 파악 가능해야 한다.

• 명사, 동사 또는 전치사로 이루어진 단어를 연결하여 만든다.

• 시작 단어를 제외한 모든 단어의 시작은 대문자로 하고 그 이외의 모든 문자는 소문자로 한다.

• 반복문을 사용할 때 index or employee 대신에 i,e를 사용하기

• 범위에 한 줄만 있어도 중괄호를 추가한다.

• 대소문자를 구별해야한다.

  • Var와 var는 다르다.

• 스위프트에서 미리 정한 키워드 및 데이터 타입 이름은 사용할 수 없다.

• 접두사 규칙 : 팀이니셜 혹은 다른 은유어들이 2자를 넘지 않도록 만든다.

• 변수명, 함수명을 지을 때 따로 정해진 규칙은 없지만 보통 "헝가리안 표기법" 지키면 좋다.

---

이름 짓기

파일명

• 파일명의 단어 첫글자는 대문자로 한다

클래스, 구조체,익스텐션, 프로토콜, 열거형 이름

• 대문자의 명사로 시작
• Pascal casing을 사용

함수, 메서드, 인스턴스 이름

• 소문자의 동사로 시작
• 함수명
  • 값의 초기화 : 접두사 init 붙인다.
  • 값의 설정 : 접두사 set 붙인다.
  • 값 얻어오기 : 접두사 get 붙인다.
  • 값 추가 : 배열 등에 값 넣을 시 접두사 push 붙인다.
  • 값 빼오기 : 배열 등에서 값 빼올 시 접두사 pop 붙인다.
  • 생성 : 접두사 create
  • 열기 : 접두사 open
  • 닫기 : 접두사 close
  • Bool 값 : 접두사 is
  • 어떤 행위를 한다 : 접두사 do
  • 입력받는다 : 접두사 input
  • 저장, 기록 : 접두사 save, write
  • 반환값이 있다, 함수가 무엇인가 나오거나 추출되어질 경우 : 접두사 get, extract, read

변수, 상수 이름

• 소문자의 명사로 시작
• 변수
  • 지역변수 : 소문자의 명사로 시작
  • 전역변수 : g_ 로 시작하기
  • 루프변수
  • 리스트 : 접미사 List 붙여주기

---

함수 만들때 규칙

• 3번 이상 호출되지 않을 경우 함수로 만들지 않기
• 간단한 한줄짜리 코드를 함수로 만들지 않기
• 내부에서만 도는 함수는 fileprivate / private로 정의하기
• 함수가 너무 길어진다면 짤라서 함수 호출 할 수 있고, 주석처리로 단위를 나눌 수 있다.
• 전제조건으로 함수는 nil을 받지 않는다.
  • 만약 nil을 받을 경우 함수이름 orNil을 붙여준다.