코딩물고기

[Javascript] 스타일 가이드 #4 본문

코딩물고기의 IT월드

[Javascript] 스타일 가이드 #4

코딩하는물고기 2021. 1. 19. 22:42
728x90

자바스크립트 스타일 가이드

10. 이름 규칙

  • 변수와 함수에 이름을 지을 때는 신중해야한다.
  • 이름은 알파벳으로 제한, 경우에 따라 밑줄 문자를 사용할 수도 있다.
  • 이름에 $표시 or \표시 사용하지 않음
  • 변수명은 낙타표기법사용, 첫 문자는 소문자로 새로운 단어의 첫 번째 문자는 대문자로 표시.
  • 변수명의 첫 번째 단어는 반드시 명사를 사용.함수와 쉽게 구분 가능해야한다.
  • 밑줄 문자는 변수명에 절대로 사용하지 않는다.
- 좋은 예
var accountNumber = '8401'

- 나쁜 예 : 대문자로 시작함
var AccountNumber = '8401'

- 나쁜 예 : 동사로 시작함
var getAccountNumber = '8401'

- 나쁜 예 : 밑줄 문자사용
var account_Number = '8401'
  • 함수명도 낙타 표기법을 사용.
  • 함수명의 첫 번째 단어는 동사를 사용하여 변수와 쉽게 구분하게 해야함
  • 함수명도 밑줄 문자 사용하지 않음
- 좋은 예
function doSomething(){
    // 코드
}

- 나쁜 예 : 대문자로 시작
function DoSomething(){
    // 코드
}

- 나쁜 예 : 명사로 시작
function car(){
    // 코드
}

- 나쁜 예 : 밑줄 사용
function Do_Something(){
    // 코드
}
  • 생성자 함수는 new 연산자를 이용. 새로운 객체를 생성할 때 사용되는 함수로, 낙타 표기법을 사용하며 첫 문자는 대문자로 시작한다.
  • 생성자 함수는 new를 이용해 객체 인스턴스를 생성하는 데 사용되므로 동사로 시작하지 않아야 한다.
- 좋은 예
function MyObject(){
    // code
}

- 나쁜 예 : 소문자로 시작
function myObject(){
    // code
}

- 나쁜 예 : 밑줄 사용
function My_Object(){
    // code
}

- 나쁜 예 : 동사로 시작
function GetMyObject(){
    // code
}
  • 변수를 값이 변하지 않는 상수처럼 사용하려면 이름의 모든 문자를 대문자로 하고,
    단어마다 밑줄을 하나 넣는다
- 좋은 예
var TOTAL_COUNT = 10;

- 나쁜 예 : 낙타 표기법
var totalCount = 10;

- 나쁜 예 : 대소문자 혼용
var total_COUNT_ = 10;
  • 객체 프로퍼티는 변수와 같이 이름 규칙을 따르며 객체 메서드는 함수와 같은 이름 규칙을 사용한다.
  • 프로퍼티나 메서드를 private으로 선언하려면 밑줄을 맨 앞에 붙입니다.
- 좋은 예 
var object = {
    _count : 10,

    _getCount : function(){
        return this_count;
    }
};

 

참고문헌 : 읽기좋은 자바스크립트 코딩 기법 / Maintainable Javascript / 니콜라스 자카스

728x90
Comments