2017-09-21 14 views
1

저는 docstring을 만드는 것과 관련하여 "솔루션 생태계"를 이해하고 PyCharm/IntelliJ를 사용하여 훌륭한 참조 문서를 생성하려고합니다.PyChars/IntelliJ가 파이썬 docstring에 어떤 스타일을 사용합니까?

나는 구글 스타일의 문서화 문자열에 사용 해요, 그리고 골격 형식/그러나 스타일의 문서화 문자열 PyCharm의 기본적으로 혼란 스러워요 :

""" 
:param <paramname>: blah blah 
:return None 
""" 

이 어떤 스타일 어떤 참조 문서 발전기가 작동 않습니다를? 어딘가에 스타일 가이드가 있습니까?

+0

에서 [reStructuredText]이다 (https://stackoverflow.com/questions/45081675/ive-been-using-this- : 여기

파이썬 문서화 문자열 유형 모두의 전체적인 설명이다 docstring-syntax-for-2-years-now-whats-it-called-who-spe) 문서화 스타일. 이 스타일은 [PEP 287] (https://www.python.org/dev/peps/pep-0287/)에 의해 지정됩니다. – CoryKramer

답변