파이썬에 대한 코드 문서

Question

파이썬 소스 코드를 문서화하기위한 규칙 및 도구에는 무엇이 있습니까?

Answer 1

Epydoc 또한 소스 코드를 문서화하기위한 좋은 도구이며, HTML, PDF, 고무로 등 상호 참조 클래스, 모듈, 변수를 처리합니다. 멋진 클래스 상속 다이어그램도 그립니다. 수많은 오픈 소스 프로젝트에서 사용되기 때문에 상당히 적극적으로 개발되고 있습니다.

Answer 2

규칙 : PEP 257 및 PEP 8. 예를 Sphinx

Answer 3

그것은 코드 자체에 코드 문서를 넣어 아주 좋다 위해 : 문서화 문자열은 문서를 생성하기위한 reStructuredText

도구로 작성 될 수 있음을 참고. 참조 :

• PEP 257 -- Docstring Conventions
• PEP 8 -- Style Guide for Python Code

Answer 4

먼저, 구조화 된 텍스트 형식을 사용하여 문서 문자열에 주석을 넣으십시오.

둘째, sphinx을 얻으십시오.

세 번째로 autodoc extension을 사용하는 인덱스를 만듭니다.

그런 다음 Sphinx를 실행하여 정말 멋진 문서를 얻으십시오.

Answer 5

doxygen을 사용하여 doxypy 필터를 사용하는 것이 좋습니다.