자바스크립트 Naming conventions

Posted on Edited on In , Word count in article: 179 Reading time ≈ 1 mins.

코드 짤때 정말 중요한 Naming rule 을 정리해놓으려고 한다

좋은 예

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
// 의미있는 이름을 사용한다
getUserPosts
var userFirstName = "John"
var userWeightInKG = 65;
var userBMI = 20;
// 구체적으로 작성한다
findUserByNameOrEmail
setUserLoggedInTrue
getUserFriend
getUserIdWithEmail(email);
getUserIdFromBlogpost(blogpostdata);
getUserIdFromChat(chatObject);
getUserIdFromFriend(friendObject);
// 동사형으로 작성한다
getQuestion
getUsers
// boolean 타입을 잘 사용한다
carIsSedan
homeWasSold
hasSessionId
userIsLoggedIn
userAllowedGPS
passwordHasExpired
// 클래스는 명사를 사용한다
class Car
new UserFriend
// 클래스는 PascalCase 를 사용한다
class Task
// 두글자 축약어는 대문자로 사용한다
let IO
let modifiedIO
getUserIdWithIP(ip)
// constant 값은 대문자로 사용한다
const HOURS_IN_DAY
const USER_AGE
// 변수명은 (lower) camelCase 를 사용한다
let redBike
// is 를 잘 사용한다
const isBlue
const isPresent
const hasProducts
// should 를 잘 사용한다
function shouldUpdateUrl
// get, set 을 잘 사용한다
function getFruitsCount
function setFruits

fetchPosts
removeFilter
deletePost
handleLinkClick

나쁜 예

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// 의미없는 이름을 사용한다
getUserInfo
getUserData
// 구체적이지 않다
findUser
// 쓸때 없는 내용 적지 말라-->
getUserFriendFromDatabase
// 명사만 사용한다
sedan
// 변수명을 한자리로 만든다
const D
let X,Y,Z
var a = "John";
var b = 65;
var c = 20;

filename 에 대한 Naiming Conventions

폴더의미에 부합되는 파일끼리 모아놓는다

1
2
3
4
5
6
7
8
9
10
11
12
/user
  api.js
  properties.js
  friends.js
  blogs.js
/users
  leaderboard.js
  search.js
  /statistics
    count.js
    friendrelations.js
    usage.js