

๊ธฐ์ตํ๊ณ ์ถ์ ๋ด์ฉ๊ณผ ๊ถ๊ธ์ฆ ๋ฐ ๊ฒฌํด
๋ง์ ๊ฐ๋ฐ์๋ค์ด ๋งํ๋ ์ ์ ํ ์ถ์ํ ๋ญ๊น?
๊ฐ๋ฐ์๋ค์ด ์์ฃผ ์ธ๊ธํ์ง๋ง ๋ง์ฐํ๊ฒ ์ดํดํ๋ ์ถ์ํ ์์ค์ ์ค์ ์์ ์ด๋ป๊ฒ ํ๋จํ๊ณ ์ ์ฉํ ์ ์๋์ง ๊ตฌ์ฒด์ ์ผ๋ก ์์๋ณด์.
tl:dr
ํจ์ ์ด๋ฆ + ์ถ์ํ ์์ค ์ผ๊ด์ฑ + ์๋ฏธ์ ์์ง๋
์ถ์ํ ์์ค์ด๋?
[3์ฅ] ํจ์

๊ธฐ์ตํ๊ณ ์ถ์ ๋ด์ฉ
์ฐ๋ฆฌ๋ ์ ์๋ค.
Javadoc ์์ @author ํ๋๋ ์ ์๋ฅผ ์๊ฐํ๋ค. ์ฐ๋ฆฌ๋ ์ ์๋ค. ์ ์์๊ฒ๋ ๋
์๊ฐ ์๋ค. ๊ทธ๋ฆฌ๊ณ ์ ์์๊ฒ๋ ๋
์์ ์ ์ํตํ ์ฑ
์๋ ์๋ค.
๋ค์์ ์ฝ๋๋ฅผ ์งค ๋๋ ์์ ์ด ์ ์๋ผ๋ ์ฌ์ค์, ์ฌ๋ฌ๋ถ์ ๋
ธ๋ ฅ์ ๋ณด๊ณ ํ๋จ์ ๋ด๋ฆด ๋
์๊ฐ ์๋ค๋ ์ฌ์ค์ ๊ธฐ์ตํ๊ธธ ๋ฐ๋๋ค.
์ฝ๋๋ฅผ ์ฝ๋ ์๊ฐ ๋ ์ฝ๋๋ฅผ ์ง๋ ์๊ฐ ๋น์จ์ด 10๋ 1์ ํ์ฉ ๋๋๋ค. ๋น์จ์ด ์ด๋ ๊ฒ ๋์ผ๋ฏ๋ก ์ฝ๊ธฐ ์ฌ์ด ์ฝ๋๊ฐ ๋งค์ฐ ์ค์ํ๋ค. ์ฝ๊ธฐ์ฌ์ด ์ฝ๋๊ฐ ์ง๊ธฐ๊ฐ ์ฝ์ง๋ ์๋๋ผ๋ ๋ง์ด๋ค. ๊ธํ๋ค๋ฉด, ์๋๋ฌ ๋๋ด๋ ค๋ฉด, ์ฝ๊ฒ ์ง๋ ค๋ฉด ์ฝ๊ธฐ ์ฝ๊ฒ ๋ง๋ค๋ฉด ๋๋ค.
[0- 1์ฅ] ๊นจ๋ํ ์ฝ๋

์ฃผ์์ด ์๋ ์์คํ ์ด ๋งํ๊ฒ ํ๊ธฐ
๋ค์ด๊ฐ๋ฉด์
์ฃผ์์ ๋ํด ์ง์งํ๊ฒ ์๊ฐํด๋ณด์๋๊ฐ? ๋จ๋ฐ์ ํ์ง ๋ง๊ณ ๊ผญ ํ์ํ๊ณณ์ ์ฃผ์์ ์ฌ์ฉํ์๋๊ฑด ์์ง๋ง ๋จ๋ฐ์ ๊ธฐ์ค์? ๊ผญ ํ์ํ๊ณณ์ ๊ธฐ์ค์? ์ ๋งค ๋ชจํธํ ๋ถ๋ถ์ ์ข ๋ ์์๋ณด๋ ค๊ณ ํ๋ค.
๋ธ๋ผ์ด์ธ w.์ปค๋ํจ, P.J.ํ๋ผ์ฐ๊ฑฐ๋ ๋์ ์ฝ๋์ ์ฃผ์์ ๋ฌ์ง๋ง๋ผ. ์๋ก ์ง๋ผ.๋ผ๊ณ ํ๋ค. ์ฝ๋๋ก ๊ทธ๋งํผ ์ถฉ๋ถํ ์๋๋ฅผ ํํํ์ง ๋ชปํ๋ค๊ณ ์ดํดํด๋ณผ ์๋ ์๋ค. single of truth๊ฐ ๋๋ ์ฝ๋๊ฐ ์ด๋ฏธ ์๋ชป๋์๋๋ฐ ์ฌ๊ธฐ์ ๋ง๋ถ์ด๋ ์ฃผ์์ ์คํ๋ ค ๋ฌธ์ ์ ์ ๋ ๊ฐ์ง๊ณ ์ฌ ์ ์๋ค๊ณ ์๊ฐํ๋ค. ์ด๋ค ๋ฌธ์ ์ ์ด๋๋ฉด ์ฃผ์์ ์ค๋๋ ์๋ก ์ฝ๋์์ ๋ฉ์ด์ง๋ค. ๊ทธ๋์ ๊ฒฐ๊ตญ ๊ฑฐ์ง๋ง์ ํ๊ฒ ๋๊ณ ํ๋ก๊ทธ๋๋จธ๋ค์ด ์ฃผ์์ ์ ์งํ๊ณ ๋ณด์ํ๊ธฐ๊ฐ ํ์ค์ ์ผ๋ก ์ด๋ ค์ ์ง๋ ๋ฌธ์ ์ ์ด๋ค.
[4 ์ฅ] ์ฃผ์ - ์ฃผ์์ด ์๋ ์์คํ
์ด ๋งํ๊ฒ ํ๊ธฐ

tl:dr
๋ถ๋ณ์๋ ํ๋ก๊ทธ๋๋จธ๋ ๋ชจ๋ ๊ฒ์ด ๊ฐ์ฒด๋ผ๋ ์๊ฐ์ด ๋ฏธ์ ์์ ์ ์๋ค. ๋๋ก๋ ๋จ์ํ ์๋ฃ๊ตฌ์กฐ์ ์ ์ฐจ์ ์ธ ์ฝ๋๊ฐ ๊ฐ์ฅ ์ ํฉํ ์ํฉ๋ ์๋ค.
์ฝ๊ณ ๋์ ๊ฒฌํด
์ฑํฐ์ ์ด๋ฐ๋ถํฐ getter/setter๋ private ๋ณ์์ ์๋ฏธ๋ฅผ ๋ฌด์ํ๊ฒ ๋ง๋๋
์๊ธฐ๋ชจ์์ ์ธ ํจํด์ด๋ผ๊ณ ๋นํํ๋ค. ๋ณ์๋ฅผ ์จ๊ธฐ๋ฉด์ ๋์์ ๋
ธ์ถํ๋ ์ด ์ด์ค๊ฐํ ์ ๊ทผ์ด ๊ฐ์ฒด๋ ์๋ฃ๊ตฌ๋์กฐ ์๋ ๋ง์น ์ต์
์ ํ์ด๋ธ๋ฆฌ๋๋ฅผ ๋ง๋๋ ๋ชจ์์ ๋ณด์ฌ์ฃผ์๋ค.
[6์ฅ] ๊ฐ์ฒด์ ์๋ฃ๊ตฌ์กฐ ๊ณฑ์น์ด๋ณด๊ธฐ

tl:dr
์ฝ๋ ํ์์ ๋จ์ํ ์คํ์ผ์ ๋ฌธ์ ๊ฐ ์๋๋ผ ์ปค๋ฎค๋์ผ์ด์
์ ๋ฌธ์ ์ด๋ค.
๊ธฐ์ตํ๊ณ ์ถ์ ๋ด์ฉ๊ณผ ๊ถ๊ธ์ฆ ๋ฐ ๊ฒฌํด
์ฃผ์ ๋ด์ฉ๋ค์ ์ ๋ฆฌํ์๋ฉด ๋ค์๊ณผ ๊ฐ๋ค.
์์ง ํ์ (Vertical Formatting)
โข
ํ์ผ ํฌ๊ธฐ: ์์ ํ์ผ์ด ์ดํดํ๊ธฐ ์ฌ์ (200~500์ค ์ ๋๊ฐ ์ ๋น)
โข
์ ๋ฌธ ๊ธฐ์ฌ์ฒ๋ผ: ์์์ ์๋๋ก ์ฝ์ ๋ ๊ณ ์์ค ๊ฐ๋
์ด ๋จผ์ , ์ธ๋ถ์ฌํญ์ ์๋๋ก
[5์ฅ] ํ์๋ง์ถ๊ธฐ - ๋จ์ํ์คํ์ผ์ด ์๋ ์ปค๋ฎค๋์ผ์ด์
์ ๋ฌธ์