10
함수, 클래스 및 모듈을 문서화하는 표준 방법은 무엇인지 알고 있지만 패키지를 문서화하는 방법은 무엇입니까? __init__.py에 문서 문자열을 넣으려면 어떻게해야합니까? 이제 패키지를 가져오고 (도움을 사용하는 경우파이썬 패키지를 문서화하는 방법
"""
This is the xyz package.
"""
:
A
답변
14
예, 단지 함수 또는 클래스 코멘트처럼 __init__.py 파일의 첫 번째 항목은 주석 문자열이어야합니다 패키지), docstring을 볼 수 있습니다. 여기에 대한 자세한 내용보기 : http://www.python.org/dev/peps/pep-0257/
3
이 PEP257
패키지는 패키지 디렉토리에있는 __의 초기화 __.py 파일의 모듈의 문서화 문자열에 기록 할 수있다 참조하십시오.
-3
문서화 너무 오래 당신이 당신의 코드에서 대부분의 사람들이이 같은 라인을 파이썬을 이해 소스를 읽고, 그래서 주석 또는 문서화하는 것을 이해하기
시도를 뭔가를 분명 문서화하지 않는 한, 좋은 생각 무의미한 :
a = 1 #this assigns 1 to a
다소 복잡한 기능이나 클래스를 주석 처리하거나 문서화하는 것이 좋습니다.
일반적 규칙 : 코드에서 작업 할 다음 사람이 미치광이가 미치광이이며 그들이 사는 곳을 알고 있다고 상상해보십시오.
그런 식으로 항상 "도움이되는"의견/의사를 남길 것입니다.