그래서 클린 코드 작성은 어떻게 하는걸까?
완벽하게 문서처럼 만든다면서?
그래서 어떤 이름으로 선언하고 어떤 규칙으로 만드는 건데?
클린 코드의 원칙은 엄청 많고 종류도 다양하다.
하나 둘씩 알아보자.
의미 있는 이름에 대해
변수를 하나 선언한다고 했을때
그 이름은 명확해야 한다.
예를 들어
이름은 줄임말로 써선 안된다.
int mca; //my cat age
이 변수는 my cat age 라는 의미를 줄임말로써 선언한 것인데,
다른 개발자가 본다면 전혀 의미를 모를 것이다.
하물며 주석을 달아서까지 이를 설명하려고도 하는데
변수 하나에 주석을 달아서 설명한다?
너무나도 비효율 적이다.
차라리 변수가 길이질지언정 그 의미를 전부 작성해서
함축적으로 내포하는 것이 좋다.
int my_cat_age;
그러면 변수명이 길어져도 상관없을까?
아래 변수를 보자.
int maximum_people_who_can_ride_oin_elevator = 20;
무려, 이렇게 길어져도 괜찮다고 한다!
긴 이름이 따로 가지는 장점이 있다고 하는데
이는 다음과 같다.
1. 해당 데이터의 의미를 정확하게 알 수 있다.
2. 어디있는지 모를 때 IDE에서 쉽게 검색이 가능하다.
3. 코드 작성시에 자동완성이 잘 작동한다.
물론 무작정 너무 길어선 안된다.
IDE에서 보이지도 않을 뿐더러
오히려 읽는데 시간이 더 든다.
변수 이름의 길이 기준은 30자 이하로 생각하고 작성하자.
항상 생각할 것은
코드를 읽는 독자가 사전지식을 가지고 있지 않은 가정하에,
용도가 명확해야 하며, 의도가 드러난 이름은
코드의 이해/변경이 수월해진다.
함수를 다시 정의해보자
실제 함수를 보고 이름들을 다시 정의해보자
def get_them(the_list):
result = []
for x in the_list:
if x.p1 > 19:
result.append(x)
return result