Skip to content

πŸ§‘β€πŸ’» Code Convention

Do Hyeon Seok edited this page Oct 12, 2024 · 3 revisions

Naming Convention

λ³€μˆ˜

ν•¨μˆ˜ 맀개 λ³€μˆ˜ 및 지역 λ³€μˆ˜, μ „μ—­ λ³€μˆ˜μ— camelCaseλ₯Ό μ‚¬μš©ν•©λ‹ˆλ‹€.

int attackSpeed = 1;

μƒμˆ˜

ν•„λ“œμ™€ 지역 μƒμˆ˜ λͺ¨λ‘ μƒμˆ˜ 이름에 PascalCaseλ₯Ό μ‚¬μš©ν•©λ‹ˆλ‹€.

const int MovementSpeed = 3;

ν΄λž˜μŠ€μ™€ ν•¨μˆ˜

클래슀 이름과 ν•¨μˆ˜ μ΄λ¦„μ—λŠ” PascalCaseλ₯Ό μ‚¬μš©ν•©λ‹ˆλ‹€.

public class DataService
{

}

프라이빗

프라이빗 μΈμŠ€ν„΄μŠ€ ν•„λ“œλŠ” 밑쀄(_)둜 μ‹œμž‘ν•˜κ³  λ‚˜λ¨Έμ§€ ν…μŠ€νŠΈλŠ” camelCasedμž…λ‹ˆλ‹€.

public class DataService
{
    private IWorkerQueue _workerQueue;
}

파일

파일 μ΄λ¦„μ—λŠ” snake_caseλ₯Ό μ‚¬μš©ν•©λ‹ˆλ‹€

였브젝트

였브젝트 이름은 PascalCaseλ₯Ό μ‚¬μš©ν•©λ‹ˆλ‹€.

image



Annotation Convention

주석은 ν•΄λ‹Ή μ½”λ“œ μœ„μ— μž‘μ„±ν•©λ‹ˆλ‹€. λͺ¨λ“  주석은 //으둜 μž‘μ„±ν•©λ‹ˆλ‹€.

// λ§Œμ•½ indexκ°€ 0보닀 크닀면
// 주석이 두 쀄인 경우
if(index > 0)
{
    return;
}



Bracket Convention

κ΄„ν˜Έμ˜ μ•ž,λ’€λŠ” 여백이 μ—†μœΌλ©°, μ€‘κ΄„ν˜Έμ˜ 경우 BSD μŠ€νƒ€μΌλ‘œ μž‘μ„±ν•©λ‹ˆλ‹€.

if(index > 0)
{
    return;
}



Spacing Convention

콜둠 & μ„Έλ―Έμ½œλ‘ 

μ—¬λ°± 없이 λΆ™μ—¬ μž‘μ„±ν•©λ‹ˆλ‹€.

switch(true){
    case 1:
    return;
}

콀마, μ—°μ‚°μž

콀마의 경우 μ•žμ€ λΆ™μ—¬μ“°λ˜ λ’€λŠ” 띄어쓰고, μ—°μ‚°μžμ˜ 경우 μ•ž,λ’€ λͺ¨λ‘ λ„μ–΄μ”λ‹ˆλ‹€.

int a, b, c;
a += b;
int a = 1;



Other Convention

  • λ“€μ—¬μ“°κΈ°λŠ” 슀페이슀 4칸을 μ‚¬μš©ν•˜λ©°, tab을 μ΄μš©ν•©λ‹ˆλ‹€.
  • 쀄 λ°”κΏˆμ€ 2쀑 이상 μ‘΄μž¬ν•΄μ„œλŠ” μ•ˆλ©λ‹ˆλ‹€.
  • Magic Number(μ½”λ“œμ—μ„œ 숫자λ₯Ό 직접 μ‚¬μš©ν•˜λŠ” 경우)λ₯Ό μ§€μ–‘ν•©λ‹ˆλ‹€.