클린 코드 (1)

클린 코드: 쉽게 읽히는 코드 작성하기

🫡코드를 작성할 때 중요한 것 중 하나는 바로 '가독성'입니다.
클린 코드는 바로 일기 쉬운 코드를 의미합니다.
코드는 사람이 읽기 쉬워야 하며, 그렇게 해야만 효율적인 유지보수가 가능합니다.
이번 글에서는 클린 코드의 원칙들에 대해 알아보고, Java를 사용한 예제를 통해 어떻게 이를 적용할 수 있는지 알아보겠습니다.

Naming (네이밍)

클린 코드의 원칙

1. 변수 이름은 명확해야 한다

   // 잘못된 예: 
   int d = 5;  // (x) 모호한 표현
   // 올바른 예: 
   int firstNumber = 5;  // (o) 명확한 표현

2. 중복 내용 제거

   코드 내에서 같은 로직이나 계산이 반복되지 않도록 주의해야 합니다.

3. 모호한 이름 제거

   // 잘못된 예: 
   int data = new User();  // (x) 모호한 표현
   // 올바른 예:
   User admin = new User();  // (o) 명확한 표현

4. 잘못된 이름 제거

   // 잘못된 예:
   Map<Integer, Integer> array = new HashMap<>();  // 배열인데 map이라고 지정할 경우

5. 명확하게 적기

   // 잘못된 예: 
   user.getData();  // (x)
   // 올바른 예: 
   user.getName();  // (o)

6. 줄임말 금지

   int ua = user.age();

   코드를 읽는 사람이 줄임말을 이해하지 못할 위험이 있으므로 사용하지 않습니다.

7. 변수는 프로젝트 내에서 일관성 있게 사용해야 한다

   같은 개념에 대해서는 프로젝트 내에서 일관된 변수 이름을 사용합니다.

네이밍 규칙

• 변수, 메소드 -> describe (설명적으로)

  int userAge = 10;

• 클래스 -> object를 표현하는 이름으로

  class User {
  
  }
  
  class Admin {
  
  }
  
  //user도 좋은 클래스 네임이지만 Admin은 보다 더 구체적으로 표현하였으므로 더 좋은 표현입니다.

• 단 boolean의 경우는 예외 -> is를 붙여주면 표현하기 편합니다.

     if (isAdmin) {
  
      }

명확하게 표현할 수 있다면 변수의 길이가 길어도 괜찮습니다. 그러나 무작정 길게 만드는 것은 피해야 합니다.

• 변수 - 명사
• 함수 - 동사
• 클래스 - 복합명사 예 (Request + Body)

주석

1. 주석은 정말 필요한 곳에만 달아야 한다.

   // 사과의 가격을 뜻합니다.
   int applePrice = 1000;

   이미 변수명을 통해 사과의 가격을 유추할 수 있으므로 없어도 되는 주석입니다.

2. 잘못 된 정보를 전달하는 주석은 제거해야 합니다.

   // 사과의 가격을 뜻합니다.
   int bananaPrice = 1000;

바나나의 가격을 표현하는 변수를 사과의 가격이라고 설명하는 잘못된 주석은 제거해야 합니다.

3. 코드 블록 주석은 삼가해야합니다.

   //int printPrice(int price) {
   //	System.out.println(price);
   //}

후에 다른 개발자에게 혼란을 줄 수 있으므로 삼가해야합니다. 필요하다면 깃등을 통해 제어 하는 것이 더 좋습니다.🫡

출처 및 참고자료

• udemy - clean code : https://www.udemy.com/course/writing-clean-code/