다른 사람의 코드 (또는 자신의)를 리팩토링하면서 숨을 쉬었다면,이 기사는 당신을위한 것입니다. 다음은 코드를 깨끗하고 읽을 수 있으며 미래를 보장하는 몇 가지 간단한 규칙입니다.

더러운 코드는 무엇입니까?

더티 코드는 코드입니다.
는 읽거나 이해하기 어렵습니다.

구조와 일관성이 부족합니다.
는 다른 것을 깨지 않고 수정하거나 디버그하기가 어렵습니다.
• 이것은 종종 개발자가 발생할 때 발생합니다 :

타이트한 마감일 아래에서 작동합니다.

코드 리뷰를 건너 뜁니다.
모범 사례 나 표준을 따르지 마십시오.
더러운 코드가 문제가되는 이유는 무엇입니까?

디버그하기가 어려워 : 하나의 버그를 수정하면 다른 5 개를 소개 할 수 있습니다.

유지 관리 비용이 많이 듭니다 : 서면으로 작성된 코드가 개선하는 데 시간이 오래 걸립니다.
Team Confusion : 새로운 개발자는 무슨 일이 일어나고 있는지 이해하려고 노력하는 데 더 많은 시간을 소비합니다. 더러운 코드는 오늘 작업을 수행 할 수 있지만 팀과 미래의 자아를위한 시한 폭탄입니다.
더러운 코드를 피하기위한 간단한 규칙

1. 단일 책임 원칙 (SRP)

를 따르십시오. 각 함수, 메소드 또는 클래스는 한 가지만 수행해야합니다. 책임이 너무 많은 방법을 작성하는 경우 더 작은 단위로 나누십시오. ] 나쁜 예 :

def process_user_data (사용자) : 사용자
= user

1 db.save (사용자) print (f "user {user

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")  

= 1 def save_user_to_db (사용자) : db.save (사용자) def log_user_update (사용자) : print (f "user {user

} 업데이트")

각 함수는 이제 하나의 명확한 작업이있어 ​​코드를 쉽게 테스트하고 수정할 수 있습니다.
2. 마법의 숫자와 문자열을 피하십시오

하드 코드 값 ( "Magic Numbers")은 코드를 읽을 수없고 유지하기가 어렵습니다. 대신 상수를 사용하십시오.

] 나쁜 예 :

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

if (statusCode === 404) { Console.log ( "찾을 수 없음"); }

] 좋은 예 :

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

const not_found = 404; if (statusCode === not_found) { Console.log ( "찾을 수 없음"); }

Constant Not_found는 자체 설명이므로 코드를 쉽게 읽을 수 있습니다.
3. 설명 변수 및 함수 이름을 작성하십시오

당신의 변수 이름은 그들이 나타내는 것을 반영해야합니다. 약어와 비밀스러운 이름을 피하십시오.

] 나쁜 예 :

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

int a = 5; 문자열 s = "존";

] 좋은 예 :

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

int userage = 5; 문자열 username = "John";

기능에 동일하게 적용됩니다. dostuff () 또는 process ()와 같은 모호한 이름을 피하십시오. 구체적으로.
4. 건조 (직접 반복하지 마십시오)

코드를 복사하고 붙여 넣으면 잘못하고 있습니다. 복제 된 코드는 버그를 악몽을 고정시킵니다. 기능 또는 클래스에 대한 추상 반복 논리.

] 나쁜 예 :

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

print ( "환영, 존") 인쇄 ( "환영, 메리")

] 좋은 예 :

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

def greet_user (이름) : print (f "환영, {name}") greet_user ( "존") greet_user ( "Mary")
5. 기능을 짧게 유지하십시오

기능이 20-30 라인보다 길면 너무 많은 일을합니다. 더 작고 재사용 가능한 기능으로 분류하십시오.

긴 기능은 특정 행동을 이해하고 테스트하기가 더 어렵습니다.
6. 드물게 의견을 사용합니다

자체를 설명하는 코드를 작성하십시오. 복잡한 논리를 명확히하기 위해 필요한 경우에만 주석을 사용하십시오. 명백한 말을하는 의견을 피하십시오.

] 나쁜 예 :

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

// 카운터를 1 씩 증가시킵니다 카운터 = 카운터 1;

] 좋은 예 :

코드가 명확한 경우 의견이 필요하지 않습니다.

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

카운터 = 1;

코드가 수행하는 일이 아니라 특정 결정이 이루어진 이유를 명확히하는 것과 같은 주석을 사용하십시오.

7. 코드 형식 및 구성

• 일관된 코딩 스타일 안내서를 따르십시오 (예 : Python 용 Pep8, JavaScript의 Eslint).
• 적절한 인기를 사용하십시오.

그룹 관련 코드가 함께. 좋은 서식은 추가 노력없이 코드를 깨끗하고 읽을 수있게합니다.

개발자의 사고 방식 : 인간을위한 코드 작성

코드는 단지 기계 용으로 작성된 것이 아닙니다. 팀원, 미래 유지 관리자 또는 심지어 6 개월이 지났습니다. 깨끗한 코드를 작성할 때 :
• 당신은 다른 사람의 정신 부하를 줄입니다.
• 당신은 디버그, 확장 및 개선을 더 쉽게 만들 수 있습니다.

당신은 품질을 중요하게 생각하는 전문 개발자처럼 보입니다.

최종 생각

더러운 코드를 피하는 것은 어렵지 않습니다. 단지 훈련이 필요합니다. 다음과 같은 간단한 규칙을 따르십시오 :
2. 단일 책임 원칙을 고수합니다.
3. 마법의 숫자를 피하십시오.
4. 명확하고 설명적인 이름을 사용하십시오.
5. 반복 코드를 건조하십시오.
6. 기능을 짧게 유지하십시오.
7. 주석을 현명하게 사용합니다.

코드를 일관되게 형식화합니다.

Clean Code는 완벽에 관한 것이 아닙니다. 작업을 유지하고 이해할 수있게하는 것입니다. 당신의 미래 자아와 팀 - 감사합니다.

이제 가서 당신이 무시한 지저분한 코드를 리팩터링하십시오! ?