Skip to content

eecsjlee/coding-convention

Repository files navigation

์ฝ”๋”ฉ ์ปจ๋ฒค์…˜

์ด ๋ ˆํฌ์ง€ํ† ๋ฆฌ๋Š” ํ”„๋กœ์ ํŠธ ์ „๋ฐ˜์— ๊ฑธ์ณ ์ผ๊ด€๋œ ๊ฐœ๋ฐœ ๋ฌธํ™”์™€ ์ฝ”๋“œ ํ’ˆ์งˆ์„ ์œ ์ง€ํ•˜๊ธฐ ์œ„ํ•ด ์ •์˜ํ•œ ์ฝ”๋”ฉ ์ปจ๋ฒค์…˜ ๋ฌธ์„œ๋ฅผ ์ •๋ฆฌํ•ด๋†“์€ ๊ณต๊ฐ„์ž…๋‹ˆ๋‹ค.
ํŠน์ • ์–ธ์–ด๋‚˜ ํ”Œ๋žซํผ์— ๊ตญํ•œ๋˜์ง€ ์•Š๊ณ , ๋‹ค์–‘ํ•œ ๊ฐœ๋ฐœ ํ™˜๊ฒฝ์—์„œ ๊ณตํ†ต์ ์œผ๋กœ ์ ์šฉํ•  ์ˆ˜ ์žˆ๋Š” ์›์น™๊ณผ ์Šคํƒ€์ผ ๊ฐ€์ด๋“œ๋ฅผ ์ค‘์‹ฌ์œผ๋กœ ๊ตฌ์„ฑ๋˜์–ด ์žˆ์œผ๋ฉฐ, ์‹ ๊ทœ ํŒ€์› ์˜จ๋ณด๋”ฉ, ์ฝ”๋“œ ๋ฆฌ๋ทฐ, ํ˜‘์—… ์‹œ ์ฐธ์กฐ์šฉ์œผ๋กœ ์‚ฌ์šฉ๋ฉ๋‹ˆ๋‹ค.

๋ฌธ์„œ ๋ชฉ๋ก

  • Code Convention
    ์ผ๋ฐ˜์ ์ธ ์ฝ”๋“œ ์ž‘์„ฑ ์‹œ ์ง€์ผœ์•ผ ํ•  ์ปจ๋ฒค์…˜์„ ์ •๋ฆฌํ•œ ๋ฌธ์„œ์ž…๋‹ˆ๋‹ค. ๋“ค์—ฌ์“ฐ๊ธฐ, ๊ณต๋ฐฑ, ์ค‘๊ด„ํ˜ธ ์‚ฌ์šฉ ๋“ฑ์˜ ๊ทœ์น™์„ ํฌํ•จํ•ฉ๋‹ˆ๋‹ค.

  • Braces Convention
    ์ค‘๊ด„ํ˜ธ({}) ์‚ฌ์šฉ์— ๋Œ€ํ•œ ๋ช…ํ™•ํ•œ ๊ทœ์น™์„ ์ •์˜ํ•œ ๋ฌธ์„œ์ž…๋‹ˆ๋‹ค. ๋ฉ”์„œ๋“œ, ์ œ์–ด๋ฌธ ๋“ฑ์˜ ์ฝ”๋“œ ๋ธ”๋ก ์ž‘์„ฑ ์‹œ ์ผ๊ด€๋œ ์Šคํƒ€์ผ์„ ์œ ์ง€ํ•˜๋Š” ๋ฐ ๋„์›€์„ ์ค๋‹ˆ๋‹ค.

  • Commit Convention
    Git ์ปค๋ฐ‹ ๋ฉ”์‹œ์ง€ ์ž‘์„ฑ ๊ทœ์น™์ž…๋‹ˆ๋‹ค. ์ปค๋ฐ‹ ํƒ€์ž…, ๋ฉ”์‹œ์ง€ ํ˜•์‹, ์˜ˆ์‹œ ๋“ฑ์„ ํฌํ•จํ•˜๊ณ  ์žˆ์–ด ์ผ๊ด€๋œ ์ปค๋ฐ‹ ํžˆ์Šคํ† ๋ฆฌ ๊ด€๋ฆฌ๋ฅผ ๋„์™€์ค๋‹ˆ๋‹ค.

  • C# Code Convention
    C# ์–ธ์–ด์— ํŠนํ™”๋œ ์ฝ”๋”ฉ ์ปจ๋ฒค์…˜์„ ๋‹ค๋ฃน๋‹ˆ๋‹ค. PascalCase, ๋„ค์ด๋ฐ ๊ทœ์น™, ์ ‘๊ทผ ์ œ์–ด์ž ์‚ฌ์šฉ ๋“ฑ .NET ํ™˜๊ฒฝ์— ๋งž๋Š” ์Šคํƒ€์ผ ๊ฐ€์ด๋“œ์ž…๋‹ˆ๋‹ค.

  • README Convention
    ํ”„๋กœ์ ํŠธ์— ํฌํ•จ๋œ README.md ์ž‘์„ฑ ์‹œ์˜ ํ˜•์‹, ๊ตฌ์กฐ, ๋ฌธ์ฒด, ์ž‘์„ฑ ์˜ˆ์‹œ ๋“ฑ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

  • ๋ ˆํฌ์ง€ํ† ๋ฆฌ ์ด๋ฆ„ ๊ทœ์น™ ๋ณด๊ธฐ
    ๋ ˆํฌ์ง€ํ† ๋ฆฌ ์ด๋ฆ„์„ ์–ด๋–ป๊ฒŒ ์ง€์„์ง€ ๊ทœ์ •ํ•ด ๋‘ 

About

A Collection of Coding Conventions and Style Guides to Ensure Clean, Consistent, and Collaborative Development Across Projects.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors