Mar*_*Bao 7 python documentation numpydoc
我正在开发一个需要Numpy文档的项目.在我的Java时代,我记得在Eclipse/IDEA中检查过Javadoc遵从性的linters; 有没有相当于检查Numpy文档样式的依从性？
我知道PEP257,但似乎没有对Numpy文档进行任何具体检查.
皮林特似乎支持这一点。看看pylint.extensions.docparams。
把它们加起来。您可以通过添加来激活此pylint检查器
load-plugins=pylint.extensions.docparams
在你的主区段.pylintrc。
此检查程序会验证所有函数，方法和构造函数docstrings是否都包含
参数及其类型
返回值及其类型
引发异常
实际上pydocstyle（以前为pep257）最近增加了对numpy docstring约定的支持。虽然，这并不完美，但我认为它与您要实现的目标最接近，并且可能会在不久的将来得到改善。
pydocstyle --convention=numpy example.py