[PEP8] Comments

• comments는 완벽한 문장이어야한다.
• 첫 번째 문자는 대문자
• 각 문장은 마침표로 끝난다.
• 여러 문장으로 작성할 때는 마침표 뒤에 공백을 두 개 사용 (마지막 문장 제외)
• 웬만하면 영어로 작성

 

Block Comments

• 뒤에 작성되는 코드에 해당하는 comments이고 들여쓰기도 해당 코드와 동일하게 적용
• #과 공백으로 시작 ('# ')

 

Inline Comments

• inline comments는 많이 사용하지 말 것
• statement와 같은 줄에 사용
• statement와 두 개 이상의 공백으로 분리되며 #과 공백으로 시작
• 해당 statement가 주석없이도 분명하다면 inline comments는 불필요

x = x + 1                 # Increment x

• 때때로 satement가 다른 의미를 가지고 있다면 다음과 같은 comments는 유용

x = x + 1                 # Compensate for border

 

Documentation Comments

• non-public한 method는 docstring이 불필요하지만 method가 하는 일을 설명하는 주석이 있어야한다.
• def 줄 다음에 작성
• 여러 줄의 docstring을 작성할 때 끝을 나타내는 """이 한 줄에 있어야함

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.
"""

• 한 줄만 작성할 때는 동일한 줄에 """으로 끝냄

"""Return an ex-parrot."""

• PEP257

 

[reference]

https://www.python.org/dev/peps/pep-0008/#comments