더티 코드: 이를 방지하기 위한 간단한 규칙

모든 개발자가 직면한 문제는 더티 코드입니다. 서둘러 작성된 것처럼 보이고 마법의 숫자, 중복된 블록, 비밀스러운 변수 이름이 뿌려진 것처럼 보이는 종류의 코드입니다. 작동합니다... 간신히요. 그런데 그걸 유지한다고? 정말 악몽이네요.

다른 사람의 코드(또는 자신의 코드)를 리팩토링하는 동안 숨이 막힐 정도로 중얼거린 적이 있다면 이 글이 도움이 될 것입니다. 다음은 코드를 깔끔하고 읽기 쉽고 미래에도 사용할 수 있도록 유지하기 위한 몇 가지 간단한 규칙입니다.

더티 코드란 무엇인가요?
더티 코드는 다음과 같은 코드입니다.

• 읽거나 이해하기 어렵습니다.
• 구조와 일관성이 부족합니다.
• 다른 것을 손상시키지 않고는 수정하거나 디버그하기가 어렵습니다.

이런 일은 개발자가 다음과 같은 경우에 자주 발생합니다.

1. 촉박한 마감 시간에 맞춰 작업하세요.
2. 코드 검토를 건너뜁니다.
3. 모범 사례나 표준을 따르지 마세요.

더티 코드가 왜 문제인가요?

• 디버깅하기 어려움: 하나의 버그를 수정하면 5개의 버그가 발생할 수 있습니다.
• 유지 관리 비용이 많이 듭니다. 잘못 작성된 코드는 개선하는 데 시간이 더 오래 걸립니다.
• 팀 혼란: 새로운 개발자는 무슨 일이 일어나고 있는지 이해하기 위해 추가 시간을 보냅니다. 더티 코드는 오늘 작업을 완료할 수 있지만 팀과 미래의 자신에게는 시한폭탄입니다.

더티 코드를 피하기 위한 간단한 규칙

1. 단일 책임 원칙(SRP)을 따르십시오
각 함수, 메서드 또는 클래스는 한 가지 작업만 수행해야 합니다. 작성 방법에 책임이 너무 많다면 더 작은 단위로 나누세요.

❌ 나쁜 예:

def process_user_data(user):
    user['age'] = user['age'] + 1  
    db.save(user)  
    print(f"User {user['name']} updated")  

✅ 좋은 예:

def update_user_age(user):
    user['age'] += 1  

def save_user_to_db(user):
    db.save(user)  

def log_user_update(user):
    print(f"User {user['name']} updated")  

이제 각 함수에는 하나의 명확한 작업이 있으므로 코드를 더 쉽게 테스트하고 수정할 수 있습니다.

2. 마법의 숫자와 문자열을 피하세요
하드 코딩된 값("마법의 숫자")은 코드를 읽을 수 없게 만들고 유지 관리하기 어렵게 만듭니다. 대신 상수를 사용하세요.

❌ 나쁜 예:

if (statusCode === 404) {  
    console.log("Not Found");  
}

✅ 좋은 예:

const NOT_FOUND = 404;

if (statusCode === NOT_FOUND) {  
    console.log("Not Found");  
}

NOT_FOUND 상수는 설명이 필요하지 않아 코드를 더 쉽게 읽을 수 있습니다.

3. 설명변수 및 함수명 작성
변수 이름은 그것이 나타내는 내용을 반영해야 합니다. 약어나 난해한 이름은 피하세요.

❌ 나쁜 예:

int a = 5;  
String s = "John";  

✅ 좋은 예:

int userAge = 5;  
String userName = "John";  

기능에도 동일하게 적용됩니다. doStuff() 또는 process()와 같은 모호한 이름은 피하세요. 구체적으로 작성하세요.

4. DRY (반복하지 마세요)
코드를 복사하여 붙여넣는다면 잘못된 작업을 하고 있는 것입니다. 중복된 코드는 버그 수정을 악몽으로 만듭니다. 반복적인 논리를 함수나 클래스로 추상화합니다.

❌ 나쁜 예:

print("Welcome, John")  
print("Welcome, Mary")  

✅ 좋은 예:

def process_user_data(user):
    user['age'] = user['age'] + 1  
    db.save(user)  
    print(f"User {user['name']} updated")  

5. 기능을 짧게 유지하세요
함수가 20~30줄보다 길면 너무 많은 일을 하고 있는 것입니다. 더 작고 재사용 가능한 기능으로 나누세요.

함수가 길면 특정 동작을 이해하고 테스트하기가 더 어려워집니다.

6. 댓글은 자제해서 사용하세요
자신을 설명하는 코드를 작성하세요. 복잡한 논리를 명확히 하기 위해 필요한 경우에만 주석을 사용하십시오. 뻔한 내용을 담은 댓글은 피하세요.

❌ 나쁜 예:

def update_user_age(user):
    user['age'] += 1  

def save_user_to_db(user):
    db.save(user)  

def log_user_update(user):
    print(f"User {user['name']} updated")  

✅ 좋은 예:
코드가 명확하면 설명이 필요하지 않습니다.

if (statusCode === 404) {  
    console.log("Not Found");  
}

코드가 수행하는 작업이 아니라 특정 결정이 내려진 이유를 명확히 하는 것과 같은 작업에는 주석을 사용하세요.

7. 코드 형식 지정 및 구성

• 일관적인 코딩 스타일 가이드를 따르세요(예: Python용 PEP8, JavaScript용 ESLint).
• 적절한 들여쓰기를 사용하세요.
• 관련 코드를 그룹화합니다. 형식을 잘 지정하면 추가 노력 없이도 코드가 깔끔하고 읽기 쉬워집니다.

개발자의 사고방식: 인간을 위한 코드 작성
코드는 기계용으로만 작성된 것이 아닙니다. 이는 팀 동료, 미래의 유지 관리 담당자, 심지어 6개월 후의 자신을 포함한 인간을 위해서도 작성되었습니다. 깔끔한 코드를 작성하는 경우:

• 다른 사람의 정신적 부담을 줄여줍니다.
• 디버깅, 확장, 개선이 더 쉬워집니다.
• 품질을 중시하는 전문 개발자 같네요.

마지막 생각
더티 코드를 피하는 것은 어렵지 않습니다. 단지 규율이 필요할 뿐입니다. 다음의 간단한 규칙을 따르십시오:

1. 단일 책임 원칙을 고수하세요.
2. 매직넘버를 피하세요.
3. 명확하고 설명이 포함된 이름을 사용하세요.
4. 반복되는 코드를 건조하세요.
5. 기능을 짧게 유지하세요.
6. 댓글을 현명하게 사용하세요.
7. 일관되게 코드 형식을 지정하세요.

클린 코드는 완벽함이 아닙니다. 작업을 유지 관리하고 이해하기 쉽게 만드는 것입니다. 미래의 당신과 당신의 팀이 감사할 것입니다.

이제 무시해 왔던 지저분한 코드를 리팩터링해 보세요! ?

위 내용은 더티 코드: 이를 방지하기 위한 간단한 규칙의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!