- 가급적이면 이름을 짧게 만들어서 tab으로 만들 수 있게끔한다.
- 패키지나 모듈 이름은 모두 소문자로만 한다.
- 모듈 이름이 길어지면 underbar를 사용한다.
- 클래스는 CapWord(CamelCase)로 작성
- Exception 클래스이면, 이름+Error를 적는다.
- 코드상 의도가 분명한 경우는 주석을 달지 않는다. -> 프린트문, 포문 등
- 주석은 대문자로 시작
- 완벽한 문장으로 끝마친다.
- 코드 변경을 하면 주석도 변경해야한다.
- 주석은 가급적 영어로 남겨야 한다.
- 주석 내용이 다루는 코드와 동일한 들여쓰기를 한다.
- 한 개의 #를 달고 기록
- 코드와 적어도 두 칸 이상 분리 후 기록
- #를 붙인 후 기록
- 굳이 남기지 않아도 되는 것은 안남긴다.
- 모듈, 클래스 ,함수, 메소드 등에 대해 정보를 제공하는 용도
- 세 개의 쌍따옴표로 문장을 감싼다.
- 함수 바로 밑에 내용을 적는다.
def function(a):
"""이것은 함수입니다.
Args:
a: 매개변수로 뭔가를 받습니다.
Returns:
result : 뭔가를 반환합니다.
"""
return result