큰 프로젝트를 할 때 참고할 만한 규칙들을 알아 보자.

1. 함수 형식

클래스에 붙은 함수를 메서드(method)라고 부른다.

클래스를 다룰 때는 클래스가 '무엇을 하도록' 만드는지 명확히 표현하자.

• 함수명은 함수가 하는 일에 따라 네이밍하지 말고, 클래스에 속한 명령으로 네이밍할 것

함수는 작고 간결하게 유지하자.

2. 클래스 형식

클래스 이름은 '낙타등 표기법(CamelCase)을 써야 한다.

• SuperGoldFactory로 쓴다.
• super_gold_factory 라고 쓰지 않는다.

__init__함수에서 너무 많은 일을 하지 말 것

• 사용하기 어렵다.

클래스 내 함수명은 '밑줄 표기법(underscore format)'을 써야 한다.

• my_awesome_hair 로 네이밍
• myawesomehair 이나 MyAwesomeHair 처럼 쓰지 말자.

함수 실행인자 구성은 일관성있게 할 것

• 클래스가 사용자, 개, 고양이를 다룬다면 그 순서를 내내 유지하자.

모듈 변수나 전역 변수를 쓰지 말자.

• 변수는 반드시 스스로 갖고 있어야 한다.

융통성있는 일관성을 갖을 것

• 다른 모두가 사용한다는 이유로 생각없이 따르지 않을 것

class 이름(object) 형식을 반드시 따를 것

class SuperGoldFactory(object):
    
    def my_awesome_hair(self):
        pass

3. 코드 형식

읽기 쉽도록 코드에 빈 줄을 넣자.

pep8 형식

• pep8을 따르도록 할 것

4. 좋은 주석

주석을 쓸 때는 왜 그렇게 하는지, 무엇을 하는지 설명하자.

함수에 문서 주석(doctring)을 할 때는 타인이 읽어도 이해할 수 있도록 작성

주석은 비교적 짧고, 핵심만 작성하자.

• 함수를 바꿨다면, 주석도 유지보수를 해야 한다.

---

Reference

• 깐깐하게 배우는 파이썬