JAVA Coding Guideline - accidentlywoo/legacyVue GitHub Wiki

JAVA Coding Guideline


1. νŒ¨ν‚€μ§€λ₯Ό ν‘œν˜„ν•˜λŠ” 이름은 λͺ¨λ‘ μ†Œλ¬Έμžλ₯Ό μ‚¬μš©.

2. λ³€μˆ˜μ˜ 이름은 μ†Œλ¬Έμžλ‘œ μ‹œμž‘ν•˜λ©° λŒ€μ†Œλ¬Έμžλ₯Ό ν˜Όμš©ν•œλ‹€.

3. μƒμˆ˜λ₯Ό ν‘œν˜„ν•˜λŠ” 이름은 λͺ¨λ‘ λŒ€λ¬Έμžλ‘œ μ§€μ •ν•˜λ˜'_'둜 단어λ₯Ό κ΅¬λΆ„ν•œλ‹€.

4. λ©”μ†Œλ“œμ˜ 이름은 동사λ₯Ό μ‚¬μš©ν•˜λ©° μ†Œλ¬Έμžλ‘œ μ‹œμž‘ν•œλ‹€.

5. private μ ‘κ·Ό μ œν•œμžλ₯Ό κ°–λŠ” 클래슀 λ³€μˆ˜μ—'_'접미사λ₯Ό μ‚¬μš©ν•œλ‹€.

6. 일반적인 λ³€μˆ˜μ˜ 이름은 νƒ€μž…μ˜ 이름과 λ™μΌν•˜κ²Œ μž‘μ„±ν•œλ‹€.

7. 넓은 λ²”μœ„μ— 영ν–₯을 λ―ΈμΉ˜λŠ” λ³€μˆ˜λŠ” κΈ΄ 이름을 λΆ€μ—¬ν•˜κ³ , 쒁은 λ²”μœ„μ˜ λ³€μˆ˜λŠ” 짧은 이름을 λΆ€μ—¬ν•œλ‹€.

8. μ°ΎλŠ” λ©”μ†Œλ“œ(find), κ³„μ‚°ν•˜λŠ” λ©”μ†Œλ“œ(compute), μ΄ˆκΈ°ν™”(initialize), μ—”ν„°ν‹° 번호(No접미사)

9. λŒ€μ‘ν•˜λŠ” 단어가 μžˆλŠ” 이름은 ν•¨κ»˜ μ‚¬μš©ν•œλ‹€. (get/set,add/remove,create/destroy,start/stop ...)

10. λΆˆλ¦¬μ–Έ λ³€μˆ˜μ˜ 이름은 뢀정적인 이름을 μ‚¬μš©ν•˜μ§€ μ•ŠλŠ”λ‹€.


  1. import문은 λ°˜λ“œμ‹œ package λ¬Έ 뒀에 λ‚˜μ™€μ•Ό ν•œλ‹€.
  2. import문을 μ‚¬μš©ν•  λ•Œμ—λŠ” μ™€μΌλ“œ μΉ΄λ“œ 문자λ₯Ό μ‚¬μš©ν•˜μ§€ μ•ŠλŠ”λ‹€.
  3. Type conversion은 λ°˜λ“œμ‹œ λͺ…μ‹œμ μœΌλ‘œ ν•΄μ€€λ‹€.
  4. λ°°μ—΄ μ§€μ‹œμ§€[]λŠ” νƒ€μž…μ˜ 이름 뒀에 μž‘μ„±ν•œλ‹€.(int[] array)
  5. λ³€μˆ˜λŠ” μ„ μ–Έλœ μ§€μ μ—μ„œ μ΄ˆκΈ°ν™”ν•˜λ©° κ°€λŠ₯ν•œ μ‚¬μš©λ²”μœ„λ₯Ό μ΅œμ†Œν™”ν•œλ‹€.