2011-04-10 4 views
3

각 클래스와 함수에 docstring을 넣어서 모듈에서의 역할을 설명 할 수 있습니다. 모듈에서 모듈의 역할을 설명하기 위해 모듈 상단에 문서 문자열을 넣을 수도 있습니다. 하지만 전체 장고 앱에 대한 문서화 문자열은 어디에 두어야합니까?전체 장고 앱에 대한 문서화 문자열 넣기

답변

8

django 앱이 패키지이기 때문에 패키지 디렉토리의 파일 docstring에 문서화 할 수 있습니다.

+0

소리가 맞다. 나는 정답이라고 느끼지만, 파이썬의 공식 스타일 가이드에서는 그것을 보지 못했다. 그것은 어딘가에 성문화되어 있습니까? – jMyles

+0

패키지 규칙에 대해 알아 보려면 http://www.python.org/dev/peps/pep-0257/ – manji