๐ก ๋์ ์ฝ๋๋ก ์ธํ ๋ฌธ์ ์
- ์ถ์์ ๋ฐ๋น ์ฝ๋๋ฅผ ์ง๋ค๋ณด๋ฉด, ๊ธฐ๋ฅ์ ์ถ๊ฐํ ์๋ก ์ฝ๋๋ ์๋ง์ด ๋์ด๊ฐ๋ค. ๊ฒฐ๊ตญ์ ๊ฐ๋นํ์ง ๋ชปํ๋ ์์ค์ ์ด๋ฅธ๋ค.
- ๋์ ์ฝ๋๋ ๊ฐ๋ฐ ์๋๋ฅผ ํฌ๊ฒ ๋จ์ด๋จ๋ฆฐ๋ค. (ํ๋ก์ ํธ ์ด๊ธฐ์๋ ๋ฒ๊ฐ์ฒ๋ผ ๋๊ฐ๋ค๊ฐ ๊ฒฐ๊ตญ ๊ตผ๋ฒต์ด์ฒ๋ผ ๊ธฐ์ด๊ฐ๋ค)
- ํ ์์ฐ์ฑ์ ๋จ์ด์ง๋ค.
- ๋ฅด๋ธ๋์ ๋ฒ์น - ๋์ค์ ๊ฒฐ์ฝ ์ค์ง ์๋๋ค. ์ฆ, ๋์ค์ ์๋ณด๊ฒ ๋ค๊ณ ์๊ฐํ ์ฝ๋๋ ๊ฒฐ์ฝ ์ค์ง ์๋๋ค๋ ์๋ฏธ์ด๋ค.
๐จ๐ป๐ป ํ๋ก๊ทธ๋๋จธ๋ค์ ์ฑ ์
- ์ข์ ์ฝ๋๋ฅผ ์ฌ์ํ๋ ์ผ์ ํ๋ก๊ทธ๋๋จธ์ ์ฑ ์์ด๋ค.
- ๊ด๋ฆฌ์๊ฐ ์ผ์ ๊ณผ ์๊ตฌ์ฌํญ์ ๊ฐ๋ ฅํ๊ฒ ๋ฐ์ด๋ถ์ด๋ ๊ฒ๋ ๊ทธ๋ค์ ์ฑ ์์ด๊ธฐ ๋๋ฌธ์ด๋ค.
- ๊ฐ์ฅ ์ข์ ๋ฐฉ๋ฒ์ ์ธ์ ๋ ์ฝ๋๋ฅผ ๊นจ๋ํ๊ฒ ์ ์งํ๋ ์ต๊ด์ ๊ฐ์ ธ์ผ ํ๋ค.
๐๐ป ๊นจ๋ํ ์ฝ๋๋?
- ๊ทธ๋ฆผ์ ๊ทธ๋ฆฌ๋ ํ์์ ๋น์ทํ๋ค. (๋น ์บํผ์ค๋ฅผ ์ฐ์ํ ์ํ์ผ๋ก ๋ฐ๊ฟ๊ฐ๋ ํ๊ฐ์ ๊ฐ๋ค)
- ๋ณด๊ธฐ์ ์ฆ๊ฑฐ์ด ์ฝ๋๋ฅผ ์๋ฏธํ๋ค.
- ๊นจ๋ํ ์ฝ๋์ ๋์ ์ฝ๋๋ฅผ ๊ตฌ๋ถํ ์ค ์๋ค๊ณ ๊นจ๋ํ ์ฝ๋๋ฅผ ์์ฑํ ์ค ์๋ค๋ ๊ฒ์ ์๋๋ค.
- ์ฝ๋ ๊ฐ๊ฐ์ ๊ฐ์ง๋ค๋ฉด ์๋ฅผ ๊ตฌ๋ถํ ์ค ์๊ณ , ์ ์ ์ ๊ท์จ์ ์ ์ฉํด ๋์ ์ฝ๋๋ฅผ ์ข์ ์ฝ๋๋ก ๋ฐ๊พธ๋ ์ ๋ต๋ ํ์ ํ๋ค
โ๏ธ ๊นจ๋ํ ์ฝ๋๋ฅผ ์ด๋ป๊ฒ ์์ฑํ ๊น?
- ๋ ผ๋ฆฌ๊ฐ ๊ฐ๋จํด์ผ ๋ฒ๊ทธ๊ฐ ์จ์ด๋ค์ง ๋ชปํ๋ค.
- ์์กด์ฑ์ ์ต๋ํ ์ค์ฌ์ผ ์ ์ง๋ณด์๊ฐ ์ฉ์ดํด์ง๋ค.
- ์ธ์ธํ ์ฌํญ๊น์ง ๊ผผ๊ผผํ๊ฒ ์ฒ๋ฆฌํ๋ ์ฝ๋๋ฅผ ๋ง๋ค์ด์ผ ํ๋ค.
์ฆ, ์ค๋ฅ์ฒ๋ฆฌ, ๋ฉ๋ชจ๋ฆฌ ๋์, ๊ฒฝ์ ์ํ, ์ผ๊ด์ฑ ์๋ ๋ช ๋ช ๋ฒ ๋ฑ ์ธ์ธํ ๋ถ๋ถ๊น์ง ์ ๊ฒฝ์จ์ผ ํ๋ค. - ํ ๊ฐ์ง์ ์ง์คํด์ผ ํ๋ค. (๋์ ์ฝ๋๋ ๋๋ฌด ๋ง์ ์ผ์ ํ๋ ค ์ ์ฐ๋ค๊ฐ ์๋๊ฐ ๋ค์์ด๊ณ ๋ชฉ์ ์ด ํ๋ ค์ง๋ค)
- ์ ์ด ๋ฌธ์ฅ์ฒ๋ผ ์ฝํ์ผ ํ๋ค. (๊ฐ๋ ์ฑ)
- ๋ค๋ฅธ ์ฌ๋์ด ๊ณ ์น๊ธฐ ์ฌ์์ผ ํ๋ค.
- ํ ์คํธ ์ผ์ด์ค๊ฐ ์์ด์ผ ํ๋ค.
- ์ฃผ์ ๊น๊ฒ ์งฐ๋ค๋ ๋๋์ ์ค์ผ ํ๋ค. (๊ณ ์น๋ ค๊ณ ํด๋ ์ ๋ ๊ณณ์ด ์๋ ๋๋)
- ์ค๋ณต์ด ์์ด์ผ ํ๋ค.
- ์ถ์ ๋ฉ์๋๋ ์ถ์ ํด๋์ค๋ฅผ ๋ง๋ค์ด ์ค์ ๊ตฌํ์ ๊ฐ์ธ ์๊ฒ ์ถ์ํํด์ผ ํ๋ค. ๊ทธ๋ฌ๋ฉด ์ค์ ๊ตฌํ์ ์ธ์ ๋ ์ง ๋ฐ๋์ด๋ ๊ด์ฐฎ๋ค.
- ์ฝ์ผ๋ฉด์ ์ง์ํ ๋๋ก ๋์๊ฐ์ผ ํ๋ค.
๐๐ป ์ฐ๋ฆฌ๋ ์ ์๋ค.
- Javadoc์์ @author ํ๋๋ ์ ์๋ฅผ ์๊ฐํ๋ค. ์ฆ, ๋ ์์ ์ ์ํตํ ์ฑ ์๋ ์๋ค.
- ๋ณด์ด์ค์นด์ฐํธ ๊ท์น (์บ ํ์ฅ์ ์ฒ์ ์์ ๋๋ณด๋ค ๋ ๊นจ๋ํ๊ฒ ํด๋๊ณ ๋ ๋๋ผ)
์ฆ, ์ฒดํฌ์์ํ ๋๋ณด๋ค ์ข ๋ ๊นจ๋ํ ์ฝ๋๋ฅผ ์ฒดํฌ์ธํ๋ค๋ฉด ์ฝ๋๋ ์ ๋ ๋๋น ์ง์ง ์๋๋ค.
๐ฃ ๋๋์
๋ญ๋ ์ง ๊ณผํ์ง ์์์ผ ํ๋ค๊ณ ์๊ฐํ๋ค.
ํด๋ฆฐ ์ฝ๋๋ฅผ ์งํค๋ ๊ฒ์ ์ข์ง๋ง, ๊ณผ๋ํ๊ฒ ํ ํ์๋ ์๋ค๊ณ ์๊ฐํ๋ค.
์ฆ, ๋๋ฌด ์๊ฒฉํ ํ์๋ ์๋ค.
ํ์์ ์์์ ์ผ๋ก ์ฐ์ตํด์ ์ต๊ด์ ๋ค์ด์.
'์ฑ > CleanCode' ์นดํ ๊ณ ๋ฆฌ์ ๋ค๋ฅธ ๊ธ
โจ Clean Code 7์ฅ: ์ค๋ฅ ์ฒ๋ฆฌ (0) | 2021.01.21 |
---|---|
โจ Clean Code 6์ฅ: ๊ฐ์ฒด์ ์๋ฃ๊ตฌ์กฐ (0) | 2021.01.20 |
โจ Clean Code 5์ฅ: ํ์ ๋ง์ถ๊ธฐ (0) | 2021.01.14 |
โจ Clean Code 3์ฅ: ํจ์ (0) | 2020.12.15 |
โจ Clean Code 2์ฅ: ์๋ฏธ ์๋ ์ด๋ฆ (0) | 2020.11.23 |
โจ Clean Code 1์ฅ: ๊นจ๋ํ ์ฝ๋ (0) | 2020.11.20 |