[Programing] Clean Code Tip

코드는 이해하기 쉬워야 한다

   - 코드를 더 좋게 만드는 건 무조건적인 간결함이 아니다

   - 가독성의 기본 원리

      (1) 코드는 다른 사람이 이해할 때 최소 시간을 들이도록 작성

      (2) 일회용으로 대강 만든 코드라도 다른 프로젝트에 쓰일 수 있다

   - 분량이 적으면 항상 더 좋은가?

      (1) 이해하기 쉬운 코드 작성이 최우선이고, 라인(Line)을 간략하게 만드는게 그 다음이다.

 

이름에 정보 담기

   - 특정 단어 선택

      (1) 재치있는 이름보다 명확하고 간결한 이름이 더 좋다

      (2) 연관성-직관성이 떨어지는 단어는 배제

   - 보편 naming(이름 짓기) 피하기

      (1) tmp나 retval 등을 쓰지 말고, 개체의 값이나 목적을 설명하는 이름으로 설정 (습관적으로 tmp를 쓰다가 코드가 길어지고 tmp가 여러 기능으로 사용되면, 이 tmp가 저 tmp인지 헷갈린다.)

      (2) tmp 는 대상이 임시로 존재하며, 임시로 존재한다는 자체가 중요할 때 한하여 쓰면 좋다

      (3) loop 반복문에선 i, j, k 보다는 member_i, lecture_j, school_k 로 표현한다면 더 명확하게 이해 가능하다.

 

출처 : wiper2019.tistory.com/248