[마무리] 클린코드

👩‍💻 클린코드

# 읽기 쉬운 코드가 클린코드이다.

"I like my code to be elegant and efficient. The logic should be straightforward and make it hard for bugs to hide, the dependencies minimal to ease maintenance, error handling complete according to an articulated strategy, and performance close to optimal so as not to tempt people to make the code messy with unprincipled optimizations. Clean code does one thing well."

- Bjarne Stroustrup, inventor of ‘C++

1. 코드가 우아하다 -> 군더더기 없이 깔끔하다.

2. 효과적이다 -> 기능을 수행하는 코드를 최대한 작은 라인으로 구현한다.

 

클린코드 -> 직접적이고 에러 처리가 잘 되어 있으며 하나의 역할을 수행한다.

“Clean code is simple and direct. Clean code reads like well-written prose. Clean code never obscures the designers’ intent but rather is full of crisp abstractions and straightforward lines of control.”

- Grady Booch, author of ‘Object-Oriented Analysis and Design with Applications’

1. 단순하고 직접적이다.

2. 원작자의 의도를 숨기지 않는다.

 

< Bjarne Stroustrup, Grady Booch의 의견 정리 >

클린코드의 가장 중요한 요소 중 하나는 가독성이라고 볼 수 있다.

즉, 모든 팀원이 이해(understandability)하기 쉽도록 작성된 코드이다.

 

---

Clean Code의 주요원칙(General)

🤔 특징

• 가독성: 누구나 코드를 읽고 쉽게 이해할 수 있어야 합니다.
• 단순성: 복잡한 로직은 최대한 간단하게 표현해야 합니다.
• 명확한 네이밍: 변수, 함수, 클래스 등의 이름은 그 역할을 명확하게 나타내야 합니다.
• 중복 없는 코드: 같은 기능을 중복으로 작성하는 대신, 공통화하여 유지보수성을 높입니다.
• 테스트 가능성: 코드를 단위별로 테스트할 수 있도록 구조화합니다.

📌 예시

class Library {
  constructor() {
    this.books = [];
  }

  addBook(book) {
    if (!book || !book.title || !book.author) {
      throw new Error('책의 제목과 저자는 필수입니다.');
    }
    this.books.push(book);
  }

  getBooksByAuthor(author) {
    if (!author) {
      throw new Error('저자 이름이 필요합니다.');
    }
    return this.books.filter(book => book.author === author);
  }

  getAllBookTitles() {
    return this.books.map(book => book.title);
  }
}

const myLibrary = new Library();

myLibrary.addBook({ title: 'Clean Code', author: 'Robert C. Martin' });
myLibrary.addBook({ title: 'JavaScript: The Good Parts', author: 'Douglas Crockford' });


console.log(myLibrary.getBooksByAuthor('Robert C. Martin'));
console.log(myLibrary.getAllBookTitles()); 

// 출력 결과
// [{ title: 'Clean Code', author: 'Robert C. Martin' }]
// ['Clean Code', 'JavaScript: The Good Parts']

 

• 명확한 네이밍 : 메소드 이름 addBook, getBooksByAuthor, getAllBookTitles는 각각 책을 추가하고, 저자별 책 목록을 가져오며, 모든 책의 제목을 반환하는 역할을 명확히 나타냅니다.
• 에러 처리 : addBook과 getBooksByAuthor 메소드는 필요한 입력값이 없을 경우 명확한 에러 메시지를 반환한다.
• 가독성 : 클래스와 메소드가 간결하며, 역할이 분명히 구분되어 있다. 누가 읽어도 이 코드가 무엇을 하는지 쉽게 알 수 있다.

 

 

 

 

참고 : https://www.samsungsds.com/kr/insights/cleancode-0823.html