[개발자의 글쓰기] - 1 . 변수 네이밍 규칙

ㅍ본 글은 "개발자의 글쓰기" 를 읽고 쓰는 회고록 입니다.

 

파스칼 표기법으로 클래스 이름 짓기

• 파스칼 표기법은 모든 단어에서 첫 글자를 대문자로 쓰는 방식.
• 주로 클래스 (iOS는 구조체도 포함) 이름에 사용.
• 클래스가 프로그래밍에서 가장 주요하고 높은 위치에 있으며, 고유명사 처럼 특정 + 명사로 되어있기 때문.

잘못된 예

interface menu
class coffeemenu implements menu

 

좋은 예

interface Menu
class CoffeeMenu implements Menu

---

카멜 표기법으로 함수, 변수 이름 짓기

• 카멜 표기법은 첫 단어를 빼고 나머지 단어의 첫 번째 글자만 대문자로 사용.
• 함수는 동작을 시키는 명령어 개념이므로 첫 단어가 주로 동사.
• 변수는 형용사로 시작하는 경우도 있음.

잘못된 예

int TotalCount = 0;
void OrderCoffee()

 

좋은 예

int totalCount = 0;
void orderCoffee()

---

상수는 모두 대문자로

• 소문자 쓰는 변수와 구별하기 위해 상수를 모두 대문자로 사용.
• 단어사이에는 언더스코어(_)로 단어를 연결.

static final int COFFEE_MAX = 10;

---

패키지, 모듈, 폴더 모두 소문자로

• 소문자로 사용하는 이유는 패키지와 모듈이 클래스를 모으거나 함수를 담아놓은 통에 불과하기 때문.
• 패키지 이름과 클래스 이름이 헷갈릴 수 있기 때문에 소문자로 사용했다는 이야기도 있음.

잘못된 예

com.goggle.kr.DeveloperWriting
import DeveloperWriting

 

좋은 예

com.google.kr.developerwriting
import developerwriting

 

다음글은 변수를 어떻게 네이밍을 할지 작명에 대해서 정리해보겠습니다.

[개발자의 글쓰기] - 2 . 변수 작명 센스 늘리기