Names

코드에 이름을 붙이는 스타일 규칙을 정리해 봐요. 출처: Zig Documentation

본문

대략적으로는 이렇게 적어요: camelCaseFunctionName, TitleCaseTypeName, snake_case_variable_name. 좀 더 정확히는 이렇게 구분해요.

x가 필드가 0개인 struct이고 절대 인스턴스화하지 않을 거라면, x는 "namespace"로 취급해서 snake_case로 적어요.
x가 type이거나 type 별칭이라면, x는 TitleCase로 적어요.
x가 호출 가능하고 반환 타입이 type이라면, x는 TitleCase로 적어요.
x가 그 외에 호출 가능한 대상이라면, x는 camelCase로 적어요.
그 밖의 경우라면, x는 snake_case로 적어요.

약어(acronym), 두문자어(initialism), 고유명사, 또는 영어 표기에서 대문자 규칙이 있는 모든 단어도 다른 단어와 똑같이 위 네이밍 규칙을 따라야 해요. 두 글자짜리 약어라도 예외가 아니에요.

파일 이름은 두 가지 부류로 나뉘어요: 타입과 namespace. 파일(암묵적으로 하나의 struct)에 최상위 필드가 있다면, 필드를 가진 다른 struct처럼 TitleCase로 이름을 지어요. 그렇지 않으면 snake_case를 쓰고요. 디렉터리 이름은 snake_case로 지어요.

이것들은 일반적인 경험칙이에요. 다르게 하는 게 더 말이 된다면 그렇게 하세요. 예를 들어 ENOENT처럼 이미 자리 잡은 관례가 있다면, 그 관례를 따르는 게 좋아요.

더 알아보기

ZIG 스타일 가이드의 전체 규칙 (#Style-Guide)
필드가 있는 struct의 이름을 짓는 법 (#Avoid-Redundancy-in-Names)
하위 문서: #Identifiers, #Source-Encoding