我正在做一个需要 Numpy 文档的项目。在我的 Java 时代，我记得在 Eclipse/IDEA 中有检查 Javadoc 遵守情况的 linter；是否有等效的检查 Numpy 文档样式的遵守情况？
我知道 PEP257，但它似乎没有对 Numpy 文档进行任何特定检查。
问问题
1813 次
1 回答
8
皮林特似乎支持这一点。看看pylint.extensions.docparams。
把它们加起来。您通过添加激活此 pylint 检查器
load-plugins=pylint.extensions.docparams
在您的.pylintrc.
此检查器验证所有函数、方法和构造函数文档字符串是否包含
参数及其类型
返回值及其类型
引发的异常
实际上pydocstyle（以前称为 pep257）最近添加了对 numpy 文档字符串约定的支持。虽然，它并不完美，但我认为它最接近您想要实现的目标，并且在不久的将来可能会有所改善。
pydocstyle --convention=numpy example.py
于 2017-03-30T17:41:11.740 回答