๊ฐ๋ฐ์ ์ฝ๋ ์ฃผ์์์ ๋ฐ๊ฒฌ๋๋ 'ํ๋ฒ/ํ ๋ฒ' ์ค๋ฅ TOP 6 ํจํด ๐๐
์๋ ํ์ธ์, ๊ฐ๋ฐ์ ์ฌ๋ฌ๋ถ! ๐ ํน์ ์ฝ๋ ์ฃผ์์ ์์ฑํ ๋ ‘ํ๋ฒ’๊ณผ ‘ํ ๋ฒ’์ ์ฐจ์ด๋ฅผ ํท๊ฐ๋ ค ๋ณธ ์ ์์ผ์ ๊ฐ์? ๐ค ์ฌ์ค ์ด ์์ ๋์ด์ฐ๊ธฐ ํ๋๊ฐ, ์ฃผ์์ ๊ฐ๋ ์ฑ๋ฟ๋ง ์๋๋ผ ํ ๋ด ์ปค๋ฎค๋์ผ์ด์ ์๋ ํฐ ์ํฅ์ ๋ฏธ์น ์ ์์ด์. ์์ฆ์ ํ์์ ์ฝ๋ ๋ฆฌ๋ทฐ ์ ๋ง์ถค๋ฒ๋ ๊ฐ์ด ์ฒดํฌํ๋ ๊ฒฝ์ฐ๊ฐ ๋ง์์ ธ์ ๋๋์ฑ ์ ๊ฒฝ ์จ์ผ ํ๋ ๋ถ๋ถ์ด ๋์์ฃ .
์ค๋์ ๊ฐ๋ฐ์๋ค์ด ์์ฃผ ์ ์ง๋ฅด๋ ‘ํ๋ฒ/ํ ๋ฒ’ ๋์ด์ฐ๊ธฐ ์ค๋ฅ TOP 6๏ธโฃ ํจํด์ ๊ผผ๊ผผํ ์ดํด๋ณด๊ณ , ์ฌ๋ฐ๋ฅธ ์ฌ์ฉ๋ฒ๊ณผ ํจ๊ป ๊น๋ํ ์ฃผ์ ์์ฑ๋ฒ๊น์ง ํจ๊ป ์๋ ค ๋๋ฆด๊ฒ์! ๐ก
๐ ์ฃผ์ ๊ฐ์: ์ ‘ํ๋ฒ’๊ณผ ‘ํ ๋ฒ’์ด ์ด๋ ๊ฒ ์ค์ํ๊ฐ? ๐จ๐ปโจ
์ฒซ์งธ, ํ๊ตญ์ด ๋ฌธ๋ฒ์์ ‘ํ๋ฒ’๊ณผ ‘ํ ๋ฒ’์ ์์ฐํ ๋ค๋ฅธ ์๋ฏธ์ ์ฐ์์๋ฅผ ๊ฐ์ง ๋จ์ด์
๋๋ค.
๋์งธ, ๊ฐ๋ฐ ๋ฌธ์์ ์ฃผ์์ ์ฝ๋ ์ดํด๋๋ฅผ ๋์ด๋ ์ค์ํ ์๋จ์ด๋ฏ๋ก, ์์ ์คํ๋ ๋์ด์ฐ๊ธฐ ์ค์๋ ํ๋กํ์
๋ํ ์ด๋ฏธ์ง๋ฅผ ๊น์ ๋จน์ฃ .
โ ๋ฐ๋ผ์ ์ ํํ ์ฌ์ฉ๋ฒ ์์ง์ ์ฃผ์ ํ๋ฆฌํฐ ๊ฐ์ ์ ๊ณง ํ์ํฌ ํฅ์๊ณผ ์ ์ง ๋ณด์ ํจ์จํ๋ก ์ง๊ฒฐ๋๋ต๋๋ค! ๐
๐ ‘ํ๋ฒ’ VS ‘ํ ๋ฒ’ ๊ธฐ๋ณธ ๊ฐ๋ ์ ๋ฆฌ ๐
๊ตฌ๋ถ | ๋ป ๋ฐ ์ฌ์ฉ ์์ |
---|---|
ํ๋ฒ (๋ถ์ฌ ์) | ๋ถ์ฌ ‘ํ๋ฒ’์ ‘์์ฃผ ๋นจ๋ฆฌ’ ๋๋ ‘๋๊ฐ’์ ์๋ฏธ๋ก |
ํ ๋ฒ (๋์ด ์) | ํ ํ, ํ ์ฐจ๋ก์ ์๋ฏธ๋ก ‘ํ’๊ณผ ‘๋ฒ’์ด ๊ฐ๊ฐ ๋ถ๋ฆฌ๋์ด ์ฌ์ฉ๋จ |
์์
- ํ๋ฒ ๋จน์ด๋ดค๋๋ฐ ๋ง์๋๋ผ. (์๋ชป๋ ๊ฒฝ์ฐ, ‘ํ ๋ฒ’์ด ๋ง์)
- ์ด๋ฒ ๊ธฐํ์ ๊ผญ ํ ๋ฒ ๋์ ํด๋ด! (์ ํํ ๋์ด์ฐ๊ธฐ)
- ๊ทธ๋ ๋์ถฉ ํ๋ฒ ์ดํด๋ดค๋ค. (๋ถ์ฌ์ ์ฉ๋ฒ์ผ๋ก ๋ถ์ฌ ์ ๊ฐ๋ฅ)
๐ ํ๊ตญ์ด ๋ง์ถค๋ฒ์ ๊ดํ ๋์ฑ ์์ธํ ๋ด์ฉ์ ๊ตญ๋ฆฝ๊ตญ์ด์ ๊ณต์ ์ฌ์ดํธ์์ ์ฐธ๊ณ ํ์ธ์.
๐ ๊ฐ๋ฐ์ ์ฃผ์์์ ํํ ๋ฐ๊ฒฌ๋๋ ‘ํ๋ฒ/ํ ๋ฒ’ ์ค๋ฅ TOP 6๏ธโฃ ํจํด
1๏ธโฃ ๋ณตํฉ ๋ฌธ์ฅ ๋ด ‘ํ๋ฒ’ ๋์ด์ฐ๊ธฐ ๋๋ฝ
// ์ฒ์ ํจ์๋ฅผ ํธ์ถํ ๋ ํ๋ฒ๋ง ์คํ๋ฉ๋๋ค.
→ ์์ )
// ์ฒ์ ํจ์๋ฅผ ํธ์ถํ ๋ ํ ๋ฒ๋ง ์คํ๋ฉ๋๋ค.
- ‘~ํ ๋’ ๋์ด์ฐ๊ธฐ ํ์
- ‘ํ ๋ฒ’์ ‘ํ + ๋ฒ’์ผ๋ก ๋์ด ์จ์ผ ํจ
2๏ธโฃ ์๊ฐ ํํ๊ณผ์ ๊ฒฐํฉ์์ ํผ๋
// ํจ์๊ฐ ํ๋ฒ ์คํ๋ ํ ์ฌ์์๋ฉ๋๋ค.
→ ์์ )
// ํจ์๊ฐ ํ ๋ฒ ์คํ๋ ํ ์ฌ์์๋ฉ๋๋ค.
- ‘ํ ๋ฒ’์ ‘๋ช ํ’๋ฅผ ์๋ฏธํ ๋ ๊ผญ ๋์ด์ฐ๊ธฐ ํ์
- ์๊ฐ ๋ถ์ฌ ‘ํ๋ฒ’๊ณผ ํผ์ฉ ๊ธ์ง
3๏ธโฃ ‘ํ๋ฒ์’ ๋ถ์ฌ๋ก ์ฐ์ด๋ ๊ฒฝ์ฐ ์ค์ฉ
// ํ๋ฒ์ ๋ชจ๋ ๋ฐ์ดํฐ๋ฅผ ์ฒ๋ฆฌํฉ๋๋ค.
→ ์์ )
// ํ ๋ฒ์ ๋ชจ๋ ๋ฐ์ดํฐ๋ฅผ ์ฒ๋ฆฌํฉ๋๋ค.
- ‘ํ ๋ฒ์’๋ ‘ํ ํ์’๋ฅผ ๋ปํ๋ ํํ
- ์กฐ์ฌ ‘์’๊ฐ ๋ถ์ผ๋ฉด ๋์ด์์ด ํ์!
4๏ธโฃ ‘ํ๋ฒ๋/ํ๋ฒ ๋’ ๋์ด์ฐ๊ธฐ ์ค๋ฅ
// ์ค๋ฅ๊ฐ ๋ ๋ ํ๋ฒ๋ ํ์ธํ์ธ์.
→ ์์ )
// ์ค๋ฅ๊ฐ ๋ ๋ ํ ๋ฒ ๋ ํ์ธํ์ธ์.
- ‘ํ ๋ฒ’ + ‘๋’ ๋ถ๋ฆฌํ์ฌ ์
5๏ธโฃ ๋ถ์ฌ ‘ํ๋ฒ’๊ณผ ๋ช ์ฌ ‘ํ ๋ฒ’์ ๋งฅ๋ฝ ํผ๋
// ์ด ๊ธฐ๋ฅ์ ํ๋ฒ๋ง ๊ฐ๋ฅํฉ๋๋ค.
→ ์์ )
// ์ด ๊ธฐ๋ฅ์ ํ ๋ฒ๋ง ๊ฐ๋ฅํฉ๋๋ค.
- ‘ํ ๋ฒ๋ง’์ ํ์๋ฅผ ์๋ฏธํ๋ฏ๋ก ๋ฐ๋์ ๋์ด์ฐ๊ธฐ ํด์ผ ํจ
6๏ธโฃ ‘์ฒ์ ํ๋ฒ’ ์กฐํฉ์์ ๋์ด์ฐ๊ธฐ ์ค์
// ์ฌ์ฉ์๊ฐ ์ฒ์ํ๋ฒ ๋ก๊ทธ์ธ์ ํ์ธํ ๊ฒ.
→ ์์ )
// ์ฌ์ฉ์๊ฐ ์ฒ์ ํ ๋ฒ ๋ก๊ทธ์ธ ์ ํ์ธํ ๊ฒ.
- ‘์ฒ์’์ ๋ถ์ฌ, ‘ํ ๋ฒ’์ ํ์ ํํ์ผ๋ก ๊ฐ๊ฐ ๋์ด ์
โ ๊น๋ํ ์ฝ๋ ์ฃผ์ ์์ฑ๋ฒ ์ฒดํฌ๋ฆฌ์คํธ ๐งน๐ป
- โญ ๋์ด์ฐ๊ธฐ ๊ธฐ๋ณธ๋ฒ์น ์์ง: ‘ํ ๋ฒ’ ๋์ด์ฐ๋ ๊ฒ ์์น!
- โ ์ฃผ์ ์์ฑ ์ ๋ฌธ์ฅ์ ์๋ฆฌ ๋ด์ด ์ฝ๊ธฐ: ๋งํ๋ ๋๋์ผ๋ก ์์ฐ์ค๋ฌ์ด์ง ํ์ธ
- ๐น ์๋ ๋ง์ถค๋ฒ ๊ฒ์ฌ ํด ํ์ฉ: VSCode, IntelliJ ๋ฑ ํ๋ฌ๊ทธ์ธ ์ ๊ทน ํ์ฉ
- ๐ก ํ ๋ด ๋ฌธ์ ๊ฐ์ด๋๋ผ์ธ ์ ์ : ๊ณตํต ์ฃผ์ ์คํ์ผ ๋ฐ ๋ง์ถค๋ฒ ๊ท์น ํต์ผ
- ๐ ์ฃผ๊ธฐ์ ์ฝ๋๋ฆฌ๋ทฐ ์ค ๋ง์ถค๋ฒ ์ ๊ฒ ๋ฐ์: ์ฝ๋ ํ์ง๋ฟ ์๋๋ผ ๋ฌธ์ ํ์ง ์ ์ง
๐ง ์ฃผ์ ์์ฑ ์ ‘ํ๋ฒ/ํ ๋ฒ’ ์ด์ธ์๋ ๊ณ ๋ คํ ์ ๋ค ๐ง๐ปโจ
1. ๋ช ํ์ฑ๊ณผ ๊ฐ๊ฒฐ์ฑ
๋๊ตฌ๋ ๋น ๋ฅด๊ฒ ์ดํดํ ์ ์๋๋ก ์งง๊ณ ๋ช
ํํ๊ฒ!
์:
// ์ด ํจ์๋ ํ ๋ฒ๋ง ํธ์ถ๋์ด์ผ ํฉ๋๋ค.
2. ์ ๋ฌธ์ฉ์ด ๋ฐ ์ฝ์ด ํด์
์ฃผ์ ์์ KPI, API ๋ฑ์ ์ฝ์ด๋ ์ฒ์ ๋ฑ์ฅ ์ ํ๊ธ ๋ฐ ์๋ฌธ ๋ณ๊ธฐ!
3. ์์ด ํผ์ฉ ๋ถ์ฃผ์
์ฝ๋ ์ฃผ์์ ํ๊ตญ์ด์ ์์ด๊ฐ ์์ผ ๋ ๋์ด์ฐ๊ธฐ·๋ง์ถค๋ฒ ๋์ฑ ์ฃผ์
๐ ํ๋ก ๊ฐ๋ฐ์์ ์ฃผ์ ํ + ํ ๋ฒ ๋ ํ์ธํ๋ ์ต๊ด โ๏ธ๐
- โญ ์ฃผ์ ์์ฑ ํ ๋ ‘๋ฆฌ๋ทฐ ํ์’์ ๊ฐ์! ๋ด๊ฐ ์ด ๋ฌธ์ฅ์ ์ค์ค๋ก ์ง๋ฌธ ๋์ง๊ธฐ
- โญ ์๋ํ ๋๊ตฌ์ ๋งก๊ธฐ๋ ๊ฒ๋ ์ค์, ํ์ง๋ง ์์ฑ๋ ์ฃผ์์ ๋ฐ๋์ ์ฌ๋์ด ์ต์ข ๊ฒํ
- โญ ‘ํ๋ฒ’๊ณผ ๊ฐ์ ์์ ์ค์๋ง ํด๋ ๋ํ๊ฐ(ใณใใฅใใฑใผใทใงใณ)์ ๋ฆฌ๋ฌ์ ๊นจ๋จ๋ฆด ์ ์์ผ๋ ์ ๋
๐ ์ถ๊ฐ ์๋ฃ ๋ฐ ์ฐธ๊ณ ๋งํฌ
- ๊ตญ๋ฆฝ๊ตญ์ด์ ๋ง์ถค๋ฒ ๊ฒ์ฌ
- ๋ค์ด๋ฒ ๋ง์ถค๋ฒ ๊ฒ์ฌ๊ธฐ
- GitHub - Code Comment Best Practices (์๋ฌธ ์๋ฃ ์ฐธ๊ณ ์ฉ)
- ๊ตญ๊ฐ๊ณต์ธ ํ๊ตญ์ด๋ฅ๋ ฅ์ํ ํํ์ด์ง
๐ฅ ๋ง๋ฌด๋ฆฌ ์ ๋ฆฌ: ‘ํ ๋ฒ’ ์ค์ ์์ด ๊น๋ํ ์ฃผ์ ๋ง๋ค๊ธฐ! ๐ฅ
โ ํต์ฌ ์์ฝ ์ฒดํฌ๋ฆฌ์คํธ
- ‘ํ๋ฒ’ vs ‘ํ ๋ฒ’ ์๋ฏธ์ ๋ฌธ๋ฒ ์ฐจ์ด ๋ช ํํ ์ดํดํ๊ธฐ
- ํญ์ ‘ํ ๋ฒ’์ ๋์ด์ฐ๊ธฐ, ‘ํ๋ฒ’์ ๋ถ์ฌ์ ์ฉ๋ฒ์ผ ๋๋ง ์ฌ์ฉ
- ์ฝ๋ ์ฃผ์ ์์ฑ ์ ์๋ฆฌ ๋ด์ด ์ฝ๊ณ , ์๋ ๋ง์ถค๋ฒ ๊ฒ์ฌ ๋๊ตฌ ์ ๊ทน ํ์ฉ
- ํ ๋ด ๋ฌธ์ ๊ฐ์ด๋๋ผ์ธ์ ๋ง์ถค๋ฒ ์ ๊ฒ ํ์คํ ์ถ์งํ๊ธฐ
- ๋ฆฌ๋ทฐ ๊ณผ์ ์์ ๋์ด์ฐ๊ธฐ ์ค๋ฅ ๊ผผ๊ผผํ ์ก๊ณ , ๋ ๋์ ์ปค๋ฎค๋์ผ์ด์ ํ๊ฒฝ ๋ง๋ค๊ธฐ
์ฝ๋ฉ๋ ์ค์ํ์ง๋ง, ์ฝ๋์ ํจ๊ป ๋จ๋ ์ฃผ์๋ ์ฌ๋ฌ๋ถ์ด ์์ฑํ๋ ‘์์ ์ํ’์
๋๋ค. ๐จ
์ค๋ ์๋ ค๋๋ฆฐ ‘ํ๋ฒ/ํ ๋ฒ’ ์ค๋ฅ TOP 6 ํจํด์ ๊ผญ ๊ธฐ์ตํ์๊ณ , ์ธ์ ๋ ๊น๋ํ ์ฃผ์์ผ๋ก ํ๋กํ์
๋ํจ UP! ๐
ํ๋ณตํ ์ฝ๋ฉ๊ณผ ๊น๋ํ ์ปค๋ฎค๋์ผ์ด์ ๋์ธ์! ๐ฉ๐ป๐จ๐ป๐
๋ ๋ง์ ๊ฐ๋ฐ ๋ฌธ์ ์์ฑ ํ๊ณผ ํ๊ตญ์ด ๋ง์ถค๋ฒ ๊ฐ์ด๋๋ ๋๊ธ๋ก๋ ๋ฌธ์ ์ฃผ์ธ์! ๐ฉ
์ด์ ๊ธ ๋ณด๊ธฐ!!