여러 줄의 들여 쓰기

Question

cmd 파이썬 모듈을 사용하는 스크립트가 있습니다. cmd 모듈은 도움말 텍스트로 삼중 인용 다중 행 문자열을 사용합니다. 이 같은 것

def x(self, strags = None): 
    """class 
    help text here 
    and some more help text here""" 

스크립트를 실행할 때 'help x'명령을 실행하면 문자열이 인쇄됩니다. 그러나 마지막 두 줄 앞에 개행 문자를 인쇄합니다. 나는이 줄을 들여 쓰지 않음으로써 이것을 극복 할 수 있지만, 그것은 내 코드를 만들 것이다.

이 들여 쓰기 문제를 극복하는 방법은 무엇입니까? 어떻게 프로 파이썬 코더가 이것을 처리합니까?

Answer 1

개인적으로 나는 PEP 8을 따르므로 Docstring Conventions에 대한 독자는 PEP 257입니다. 다중 행 문서화에 대한 전체 섹션이 있습니다.

Answer 2

나는이 같은 일관된 들여 쓰기를함으로써 그것을 처리 할 것 :

는

def x(self, strags = None): 
    """ 
    class 
    help text here 
    and some more help text here 
    """ 

물론, 그것은 더 두 줄이 필요하지만 그것은 또한 다큐 멘 테이션 코멘트가 상당히 눈에 띄는함으로써 (제 생각에) 선명도를 주입 잘.