Vì vậy, tôi đã phần nào được sử dụng cho tài liệu kiểu Javadoc. Nhìn qua các ví dụ khác nhau về mã Python, tôi thấy rằng, lúc đầu đỏ mặt, tài liệu có vẻ như bị thiếu nhiều thông tin.Di chuyển từ Javadoc sang Tài liệu Python
Điều tốt: thay đổi hiếm khi bạn thấy các tài liệu rõ ràng. Tài liệu thường là một đoạn văn hoặc ít hơn của đánh dấu tiếng Anh tích hợp thay vì đứng ra trên các dòng riêng biệt.
Điều xấu: kết hợp với việc nhập vịt của Python, tôi thấy rằng nhiều hàm không rõ ràng về các tham số mà chúng mong đợi. Không có gợi ý loại (vịt-hinting) và thường lần nó sẽ được tốt đẹp để có một số ý tưởng rằng các tham số nên được danh sách giống như, giống như chuỗi, giống như dòng.
Tất nhiên, Javadoc được thiết kế cho một ngôn ngữ cấp thấp hơn, mà không có khả năng nội tâm tuyệt vời của Python, có thể giải thích cho triết lý tài liệu ít chi tiết hơn.
Bất kỳ lời khuyên nào về các tiêu chuẩn tài liệu Python và các phương pháp hay nhất?
câu hỏi là gì? –
Đó là loại kết thúc mở. Tôi đã thêm rằng tôi đang tìm kiếm lời khuyên. – Koobz
Tư vấn về những gì? Bạn có đang viết phần mềm và muốn cung cấp tài liệu không? Hay bạn đang phàn nàn rằng bạn không thể tìm thấy những thứ trong tài liệu thư viện Python? "Tài liệu Python ... dường như thiếu nhiều thông tin" chỉ là một khiếu nại. Bạn đang gặp khó khăn khi làm gì? –