tài liệu mã cho python

Question

Điều gì ở ngoài đó trên các quy ước và công cụ để ghi lại mã nguồn python?

Answer 1

Epydoc cũng là một công cụ tốt cho tài liệu mã nguồn, và xử lý các lớp học tham khảo chéo, mô-đun, các biến, vv, sang HTML, PDF, LaTeX. Rút ra một số sơ đồ thừa kế lớp tốt đẹp quá. Nó được sử dụng bởi một số dự án mã nguồn mở, vì vậy nó khá tích cực phát triển.

Answer 2

Quy ước: PEP 257 và PEP 8. Lưu ý, rằng docstrings thể được viết bằng reStructuredText

Công cụ để tạo ra các tài liệu: ví dụ Sphinx

Answer 3

Nó rất tốt đẹp để đưa tài liệu mã trong mã riêng của mình. Xem:

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

Answer 4

Trước tiên, hãy đặt nhận xét trong tài liệu của bạn bằng định dạng Cấu trúc lại.

Thứ hai, nhận sphinx.

Thứ ba, tạo chỉ mục sử dụng số autodoc extension.

Sau đó, chạy Nhân sư để nhận tài liệu thực sự tốt đẹp.

Answer 5

sử dụng bộ lọc doxypy với doxygen là một điều tốt cũng