Skip to content

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

Notifications You must be signed in to change notification settings

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

No packages published