Naming Convention - Att-ies/frontend GitHub Wiki

λ³€μˆ˜λͺ…

  1. 단어가 3κ°œκΉŒμ§€λ§Œ λ“€μ–΄κ°€κ²Œ 지을 것.

    • λ„ˆλ¬΄ κΈΈμ–΄μ§„ λ³€μˆ˜λŠ” 읽기 νž˜λ“­λ‹ˆλ‹€.

    예) getElementInt (o) / getBackendElementInt (x)

  2. Sum, Average, Count, Max 같이 νŠΉμ • μ–‘μ΄λ‚˜ μ΅œλŒ€ μ΅œμ†Œλ₯Ό λ‚˜νƒ€λ‚΄λŠ” 것듀은 λ’€μ˜ λ‹¨μ–΄λ‘œ μ“Έ 것.

    예) studentCount (o) / countStudent (x)

  3. 같은 의미의 λ³€μˆ˜μΌ λ•Œ, λ‚΄λΆ€ ν•¨μˆ˜μ˜ λ³€μˆ˜λŠ” 더 짧은 λ³€μˆ˜λ₯Ό μ‚¬μš©ν•  것

  4. λ°°μ—΄, λ”•μ…”λ„ˆλ¦¬ λ“±λ“±μ˜ νƒ€μž…μΌ 경우 s ν˜Ήμ€ list, arr λ“±λ“± ν‘œμ‹œλ₯Ό 뢙일 것.

    • distance = [1, 3, 10] (x)
    • distances = [1, 3, 10] (o)
    • distance_list = [1, 3, 10] (o)

ν‘œκΈ° 방법

λͺ¨λ‘ λŒ€λ¬Έμž) ex. DOMAIN

  • μƒμˆ˜ | URL μ΄λ‚˜ 도메인 이름 | κ·Έλƒ₯ λ‹¨μˆœν•œ κΈ°ν˜Έλ‚˜ λ¬Έμžμ—΄μΈλ° λ³€μˆ˜λ‘œ μ“°λ €κ³  ν•  λ•Œ
  • μ›λž˜ κ΄€μŠ΅μ μœΌλ‘œ λŒ€λ¬Έμžλ‘œ 자주 μ“°λŠ” 것듀 (예 : ID, URL, IP, λ“±λ“±)

파슀칼 μΌ€μ΄μŠ€) ex. MainState

  • νƒ€μž… 이름 | μΈν„°νŽ˜μ΄μŠ€ 이름 | 클래슀 이름
  • μ ˆλŒ€ μ•ˆλ³€ν•˜κ³  μ‚¬μš©λ§Œ λ˜λŠ” λ‹¨μˆœ ν•¨μˆ˜, λ‚΄μš©μ μΈ μ˜λ―Έλ„ μ€‘μš”ν•˜μ§€ μ•Šμ•„μ•Ό 함.
    • redux μ—μ„œ Action ν•¨μˆ˜ 같은거

카멜 μΌ€μ΄μŠ€) ex. getLoginPassword

  • 일반 ν•¨μˆ˜
  • μ•„λž˜μ—μ„œ λ‚˜μ˜¬ μ–΄λ―Έ + ~~ λ“€
  • 객체의 propertyλ“€

μŠ€λ„€μ΄ν¬ μΌ€μ΄μŠ€) ex. add_avail

  • 일반적인 두 단어 이상 λ³€μˆ˜λ“€ | int, bool, string λ“±λ“± 일반적인 νƒ€μž…μ˜ λ³€μˆ˜λ“€
  • array, dictionary νƒ€μž…μ€ s λ₯Ό λΆ™μ—¬μ€€λ‹€.

[ν•¨μˆ˜ μ•žμ— 어두]

μƒˆλ‘œ 생성 : make / λ§žλŠ”μ§€ μ—¬λΆ€ : is (bool) / κ°€λŠ₯ν•œμ§€ μ—¬λΆ€ : can / μ„€μ •ν•˜κΈ° : set (void) / λ°›μ•„μ˜€κΈ° : get

[λ³€μˆ˜ λ’€ μ–΄λ―Έ]

κ°€λŠ₯ν•œμ§€ μ—¬λΆ€ : avail / μ°Ύμ•˜λŠ”μ§€ μ—¬λΆ€ : found / μ—λŸ¬ μ—¬λΆ€ : error | err / λλ‚¬λŠ”μ§€ μ—¬λΆ€ : done

[숫자]

λˆ„μ  횟수 : count, cnt / 인덱슀 : index, idx / νŠΉμ • 번호 : num

  • handle~, on~ [μ°Έκ³  링크](https://ellie-dev.tistory.com/13)

    • on 접두사가 뢙은 경우, 이 prop에 μ‹€μ œ μ΄λ²€νŠΈκ°€ μ—°κ²°λ˜μ–΄ μžˆλ‹€λŠ” κ±Έ λœ»ν•˜κ³ ,
    • handle 접두사가 뢙은 경우, μ΄λ²€νŠΈκ°€ λ°œμƒν–ˆμ„ λ•Œ ν˜ΈμΆœλ˜λŠ” μ‹€μ œ Function을 의미
  • μ˜ˆμ‹œ

    function App() {
        const handleRegistrationSubmit = () => {}
        const handleLoginSubmit = () => {}
         return (
            <Form 
                onRegistrationSubmit={handleRegistrationSubmit}
                onLoginSubmit={handleLoginSubmit}
            />    
        )
    }
    

파일, 폴더λͺ…

  1. 폴더 이름은 μ΅œλŒ€ν•œ 짧게

  2. μ—¬λŸ¬ νŒŒμΌμ„ λΆ„λ₯˜ν•΄λ‘λŠ” 폴더면 s λ₯Ό 뢙일 것.

  • model (x) / models (o)
  1. λ‚ μ§œ, ν•™λ²ˆ, λ“±λ“±μ˜ μ •λ³΄λŠ” 맨 μ•žμ—.
  • 200713_update_data.py
  1. 순차적 번호 같은 인덱슀 μ •λ³΄λŠ” 맨 뒀에
  • λ‚ μ§œλ„ 순차적인 μ˜λ―Έκ°€ ν•„μš”ν•œ κ²½μš°λŠ” 맨 뒀에.

μ΄λŸ¬ν•œ 경우 = 이름 > λ‚ μ§œ > 순번

  • data01.js / data02.js
  1. μ—¬λŸ¬ 단어가 λ“€μ–΄κ°„λ‹€λ©΄ 큰 ν•­λͺ©μ—μ„œ μž‘μ€ ν•­λͺ©μœΌλ‘œ 뢙일 것
  • layout_style_line.~~

image

κ·Έ μ™Έ μ½”λ”© μ»¨λ²€μ…˜

  1. μ„ μ–Έκ³Ό λ™μ‹œμ— 할당을 ν•˜λŠ” λ³€μˆ˜ λ¨Όμ € μ„ μ–Έν•œλ‹€. (ES5)

    μ„ μ–Έκ³Ό 할당을 ν•¨κ»˜ν•˜λŠ” λ³€μˆ˜μ™€ μ„ μ–Έλ§Œ ν•˜λŠ” λ³€μˆ˜κ°€ ν•¨κ»˜ μ‚¬μš©λ  λ•Œ, μ„ μ–Έκ³Ό λ™μ‹œμ— 할당을 ν•˜λŠ” λ³€μˆ˜λ₯Ό κ·Έλ£Ήν™”ν•˜μ—¬ λ¨Όμ € μ„ μ–Έν•˜λŠ” 것이 가독성에 μ’‹λ‹€.

  2. λ°°μ—΄κ³Ό κ°μ²΄λŠ” λ°˜λ“œμ‹œ λ¦¬ν„°λŸ΄λ‘œ μ„ μ–Έν•œλ‹€.

    λ¦¬ν„°λŸ΄ ν‘œκΈ°λ²•μ€ μƒμ„±μž ν•¨μˆ˜λ³΄λ‹€ μ§§κ³  λͺ…ν™•ν•˜λ©° μ‹€μˆ˜λ₯Ό 쀄일 수 μžˆλ‹€.

  3. ν•œ μ€„μ§œλ¦¬ 블둝일 κ²½μš°λΌλ„ {}λ₯Ό μƒλž΅ν•˜μ§€ μ•ŠμœΌλ©° λͺ…ν™•νžˆ 쀄 λ°”κΏˆ ν•˜μ—¬ μ‚¬μš©ν•œλ‹€.

    ν•œ μ€„μ§œλ¦¬ 블둝일 경우 {}λ₯Ό μƒλž΅ν•  수 μžˆμ§€λ§Œ, μ΄λŠ” μ½”λ“œ ꡬ쑰λ₯Ό μ• λ§€ν•˜κ²Œ λ§Œλ“ λ‹€. λ‹Ήμž₯은 두 쀄을 쀄일 수 μžˆκ² μ§€λ§Œ 이후 였λ₯˜ λ°œμƒ ν™•λ₯ μ΄ λ†’μ•„ 잠재된 μœ„ν—˜ μš”μ†Œκ°€ λœλ‹€.

  4. (μ§€μ—­ λ³€μˆ˜ or private λ³€μˆ˜)λͺ…은 '_'둜 μ‹œμž‘ν•œλ‹€.

  5. constλ₯Ό let 보닀 μœ„μ— μ„ μ–Έν•œλ‹€.

  6. const와 let은 μ‚¬μš© μ‹œμ μ— μ„ μ–Έ 및 할당을 ν•œλ‹€.