20. 클린코드 가이드

위키북스 박응용 저 "점프 투 파이썬" 책을 읽고 정리한 내용입니다.

다소 잘못된 내용과 구어적 표현 이 포함되어 있을 수 있습니다.

DOCSTRING 적기

"""함수설명
Args:
	변수1(자료형):설명
	변수2(자료형):설명
 
Returns:
	자료형: 반환값 설명
"""

함수에 필요한 변수를 초기화할때 가변객체말고 불변객체 를 사용해라
- 예를들어 매개변수로 리스트를 받으려고 할때 a=[] 이렇게 주지 말고 a=None 이렇게 주는것이 안전하다
- 함수가 동작하는 중에 저 변수를 사용하면 기본값이 변경되기 때문
- 솔직히 뭔말인지 잘 모르겠다
불리언 연산식을 적을때는 암시적인 표현법 을 사용하는 것이 더 안전하고 가독성이 높다
- 리스트가 비어있다는걸 len(리스트) == 0 으로 표현하는것보다는 not 리스트 이렇게 표현한다
- 리스트가 비면 당연히 False 값을 갖는데 굳이 길이가 0이라고 명시적으로 적어주면 가독성이 떨어진다 이말이다
특정대상(예를들면 정수)이랑 비교하는 불리언 연산식의 경우 비교대상이랑 직접적으로 비교하는 연산식 으로 적어주는게 좋다
- 변수 is not None and not 변수 이렇게 적지 말고 변수 == 0 이렇게 직접 적어주는 것이 좋다
- 마찬가지로 not 변수 % 2 이렇게 말고 변수 % 2 != 0 이게 직접비교가 더 좋다더라
한 문장의 길이는 80자를 넘지 않도록 해야된다
- 모니터를 큰거를 써도 한문장이 80자를 넘어가게 되면 가독성이 떨어지더라