언어별로 클린코드를 작성하기 위해 분류해둔 문서입니다.


클린코드 공통

0. 언어별 코딩표준 준수 ( 꼭 지키자! )

  1. null 사용 자제

    1. 널을 남용할 시 프로그램이 죽을 확률이 많아지고 어디서 죽었는지 정확히 파악하기 어려워질 수 있다.
  2. 부정 조건문 사용하지 말 것

    1. 부정 조건문이라 생각을 한번 더 해야하고 헷갈릴 수 있는 여지가 있다.
    // 이런 조건문 사용하지 말 것
    if (!is_empty(list)) {
    	// code
    }
    
    // is_not_empty() 함수를 하나 더 만들어 사용하자
    if (is_not_empty(list)) {
    	//code
    }
    
  3. 3 ~ 4 depth 이상 들어가지 말것

    2-1. if else 문 사용 자제 ( else 예약어 사용 자제 )

    // 이렇게 사용하지 말 것.
    if ( 조건문 1 ) {
    	// code
    } else {
    	// code
    }
    
    //이렇게 바꾸기
    if ( 조건문 1 ) {
    	// code
    	return;
    }
    //code
    

    2-2. 중첩 if문 사용하지 말 것

    2-3. 코드가 길어질 시 함수로 분할할 것

    2-4. 레고블럭 쌓기

  4. 함수는 하나의 동작만을 할 것

  5. 매직 넘버 사용하지 말 것

    1. 매직 넘버를 사용하면 이해하기가 어려움
    // WARNING
    double result = 5 * 3.141592
    
    // GOOD
    const double PI = 3.141592
    double result = 5 * PI
    

    출처 : https://github.com/CodeSoom/spring-week1-assignment-1/discussions/59


언어별 클린코드 분류 문서

C 클린코드

Java 클린코드