[마무리] 클린코드와 닌자코드

🥷 닌자코드

닌자라 불리던 전설 속 개발자들은 유지보수 담당 개발자를 혹독하게 훈련하기위해 다양한 편법을 사용했다.

1. 코드 짧게 쓰기
2. 글자 하나만 사용하기
3. 약어 사용하기
4. 포괄적인 명사 사용하기
5. 철자가 유사한 단어 사용하기
6. 동의어 사용하기
7. 이름 재사용하기
8. 재미로 언더스코어 사용하기
9. 과장 형용사 사용하기
10. 외부 변수 덮어쓰기
11. 부작용이 있는 코드 작성하기
12. 함수에 다양한 기능 넣기

// 출처: 아주 유명한 라이브러리
i = i ? i < 0 ? Math.max(0, len + i) : i : 0;

function ninjaFunction(elem) {
  // 매개변수로 받아온 elem을 이용한 코드

  elem = clone(elem);

  // elem의 복제(clone)본을 이용한 코드
}

 

📌 클린코드와 닌자코드 비교

가독성	누구나 쉽게 이해 가능	작성자 본인만 이해 가능
유지보수성	수정 및 확장이 용이	수정 시 오류 발생 가능성 높음
코드 스타일	명확한 네이밍, 중복 최소화, 간결한 구조	짧고 축약된 코드, 가독성 낮음
에러 처리	적절한 에러 메시지 제공	불명확한 에러 처리 방식

 

💻 닌자코드 예시

class L {
  constructor() {
    this.b = [];
  }

  aB(b) {
    if (!b || !b.t || !b.a) throw '필수 정보 누락';
    this.b.push(b);
  }

  gB(a) {
    if (!a) throw '저자 필요';
    return this.b.filter(x => x.a === a);
  }

  gT() {
    return this.b.map(x => x.t);
  }
}

const l = new L();

l.aB({ t: 'Clean Code', a: 'Robert C. Martin' });
l.aB({ t: 'JavaScript: The Good Parts', a: 'Douglas Crockford' });


console.log(l.gB('Robert C. Martin'));
console.log(l.gT()); 

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

 

• 축약된 변수와 함수 이름
  • L 대신 Library가 아닌 축약된 클래스 이름을 사용
  • 함수 이름들도 aB, gB, gT처럼 축약되어 있어 어떤 기능을 하는지 명확하지 않다.
  • 변수 b, t, a 역시 불명확하며, 코드를 읽는 사람은 이들이 각각 books, title, author를 의미하는지 즉시 파악하기 어렵다.
• 간단한 에러 메시지
  • 명확한 에러 메시지 대신 "필수 정보 누락", "저자 필요"처럼 매우 간략한 메시지만 던지고 있어, 문제가 발생했을 때 정확한 원인을 파악하기 어렵다.
• 가독성 저하
  • 변수와 함수 이름이 모두 축약되어 있어 코드의 의도를 파악하기 힘들다. 코드가 짧게 작성되었지만, 유지보수와 확장성이 크게 떨어진다.

-> 클린코드는 협업과 장기적인 코드 유지에 필수적인 방식이다. 명확한 네이밍과 간결한 구조는 유지보수성을 높이고, 코드 품질을 개선하는 데 도움이 된다.

 

 

🤣 닌자 코드 요약

1. 편법 중 몇 개만 사용해도, 놀라운 코드를 만들 수 있게 된다.

2. 편법을 많이 사용하면 유지 보수하기가 힘들어져서 당신을 해고할 수 없다.

3. 편법을 모두 사용하면 후배 개발자들에게 엄청난 영감을 심어줄 수 있다.

 

https://kr.freepik.com/free-vector/flat-design-ninja-logo-template_15477911.htm#fromView=search&page=1&position=4&uuid=f3dbace2-e7c0-4637-9f80-d6e87495529d

 

참고 : 모던 JavaScript 튜토리얼

https://ko.javascript.info/ninja-code

닌자 코드