Tôi đang làm việc trên một dự án yêu cầu tài liệu về Numpy. Trong các ngày Java của tôi, tôi nhớ có các linters đã kiểm tra sự tuân thủ Javadoc trong Eclipse/IDEA; có tương đương với việc kiểm tra sự tuân thủ theo kiểu tài liệu Numpy không?Có cách nào để lint một tập tin Python để kiểm tra tuân thủ theo kiểu tài liệu Numpy không?
Tôi biết về PEP257, nhưng dường như không có bất kỳ kiểm tra cụ thể nào cho tài liệu về Numpy.
Pylint dường như hỗ trợ điều đó. Hãy xem pylint.extensions.docparams.
Để tổng hợp. Bạn kích hoạt trình kiểm tra này pylint bằng cách thêm
load-plugins=pylint.extensions.docparams
trong phần Master of .pylintrc của bạn.
trình kiểm tra này xác nhận rằng tất cả các chức năng, phương pháp và xây dựng docstrings bao gồm tài liệu hướng dẫn của
thông số và các loại họ
giá trị trả về và kiểu của nó
ngoại lệ đã nâng cao
Trên thực tế pydocstyle (trước đây là pep257) recently added support cho ước docstring NumPy. Mặc dù, nó không hoàn hảo Tôi nghĩ rằng đó là gần nhất với những gì bạn muốn đạt được và nó có thể sẽ cải thiện trong tương lai gần.
pydocstyle --convention=numpy example.py
trình kiểm tra có thể xử lý gọn gàng (trong số những thứ khác như Sphinx) và kiểm tra những thứ đó, nhưng tôi không nghĩ rằng nó có cách phân biệt với các kiểu khác. Ví dụ, nếu bạn viết mã với tài liệu Sphinx rằng linter vẫn sẽ nói nó là tốt, ngay cả khi bạn chỉ muốn phong cách gumpy - Tôi không thấy một cách để chỉ định một phong cách tài liệu độc quyền – Andrew
@Andrew, hmmm xin lỗi có vẻ như tôi đã bỏ lỡ để đưa vào tài khoản mà một phần của sự tuân thủ, tôi đã cập nhật câu trả lời của tôi. –