0
pep8、pyflakes、およびpylintを使用してコードを実行します。すべて私のPythonコードの内容とフォーマットを検証します。Python：検証クラスとメソッドは適切に文書化されています（型、引数、戻り値、例外）？
私が今探しているのは、私のPythonコードが適切かつ完全にコメントされていることを検証することです。たとえば、すべてのメソッドにコメントがあり、それらのメソッドの引数のそれぞれもコメントされ、期待されるリターンと例外があるとします。いくつかのクラスと定数とプロパティの真です。
私は、文書生成のためにSphinxとDoxygenでコードを実行します。
Thxを
あなたは[doc testing]（http://www.sphinx-doc.org/en/stable/ext/doctest.html）を探していると思います。また、メインの[こちら]（https://docs.python.org/3/library/doctest.html）からも入手できます。将来の参照のために、通常はソフトウェアの推奨事項を尋ねるのはSOの話題にはならない。 – idjaw
私は "コメント"は "文書化された"と置き換えられるべきだと思います。コメント！= docstrings。 – mzjn
ご返信ありがとうございます。正解、私は**よく書かれた**コードを参照していました。しかし、** [doctest]（https://docs.python.org/3/library/doctest.html）**モジュールは、インタラクティブなPythonセッションのように見えるテキストを検索し、それらのセッションを実行して示されているとおりに正確に動作します。 – jeff00seattle