πŸ“Œ Code Convention - prgrms-be-devcourse/NBE4-5-3-Team01 GitHub Wiki

β˜‘οΈ μ½”λ“œ μ»¨λ²€μ…˜

1. λ¬Έμžμ—΄μ„ μ²˜λ¦¬ν•  λ•ŒλŠ” μŒλ”°μ˜΄ν‘œλ₯Ό μ‚¬μš©ν•˜λ„λ‘ ν•©λ‹ˆλ‹€.

2. λ¬Έμž₯이 μ’…λ£Œλ  λ•ŒλŠ” μ„Έλ―Έμ½œλ‘ μ„ λΆ™μ—¬μ€λ‹ˆλ‹€.

3. ν•¨μˆ˜λͺ…, λ³€μˆ˜λͺ…은 μΉ΄λ©œμΌ€μ΄μŠ€λ‘œ μž‘μ„±ν•©λ‹ˆλ‹€.

4. 가독성을 μœ„ν•΄ ν•œ 쀄에 ν•˜λ‚˜μ˜ λ¬Έμž₯만 μž‘μ„±ν•©λ‹ˆλ‹€.

5. 주석은 μ„€λͺ…ν•˜λ €λŠ” ꡬ문에 맞좰 λ“€μ—¬μ“°κΈ° ν•©λ‹ˆλ‹€.

// Good
function someFunction() {
  ...

  // statement에 κ΄€ν•œ 주석
  statements
}

6. μ—°μ‚°μž μ‚¬μ΄μ—λŠ” 곡백을 μΆ”κ°€ν•˜μ—¬ 가독성을 λ†’μž…λ‹ˆλ‹€.

a+b+c+d // bad
a + b + c + d // good

7. 콀마 λ‹€μŒμ— 값이 올 경우 곡백을 μΆ”κ°€ν•˜μ—¬ 가독성을 λ†’μž…λ‹ˆλ‹€.

var arr = [1,2,3,4]; //bad
var arr = [1, 2, 3, 4]; //good

8. μƒμ„±μž ν•¨μˆ˜λͺ…μ˜ 맨 μ•žκΈ€μžλŠ” λŒ€λ¬Έμžλ‘œ ν•©λ‹ˆλ‹€.

function Person(){}

β˜‘οΈ μ½”λ“œ μ»¨λ²€μ…˜μ΄ ν•„μš”ν•œ 이유

  • νŒ€μ›λΌλ¦¬ μ½”λ“œλ₯Ό κ³΅μœ ν•˜κΈ° λ•Œλ¬Έμ— μΌκ΄€μ„±μžˆλŠ” μ½”λ“œλ₯Ό μž‘μ„±ν•˜λ©΄ μ„œλ‘œ μ΄ν•΄ν•˜κΈ° 쉽닀.
  • λ‚˜μ€‘μ— μž…μ‚¬ 지원 μ‹œ ν”„λ‘œμ νŠΈλ₯Ό ν•˜λ©° μ½”λ“œ μ»¨λ²€μ…˜μ„ λ§Œλ“€μ–΄ μ§„ν–‰ν–ˆλ‹€κ³  ν•˜λ©΄ ν˜‘μ—… λ©΄μ—μ„œ μœ λ¦¬ν•˜κ²Œ μž‘μš©ν•  수 μžˆλ‹€.