私はPyCharm IDEを使用します。これはPEP0257準拠のdocstringの作成を支援します。この2つの属性を提供します。
:raise Exception: exception explanation here
:raises Exception: exception explanation here
Docstringでraise
に反してraises
を使用するのはいつですか?具体的には、クラスが提供されていない引数を必要とし、TypeError
を発生させる場合、それを文書化するために使用する必要がありますか?
TL; DR
raises
は、発生する可能性のある例外を記述するために使用されます。 raise
は、autodocの実行時に Sphinx によって認識され、raises
と同じです。
完全な説明
PyCharmは、いくつかの異なるスタイルのdocstringコメントの使用を支援します。
私がよく使用する3つは次のとおりです。
これらのすべてには、Raises
の特別なセクションがあり、それはPyCharmコードテストの古いバージョンで見ることができます:
SphinxDocString
の実装 こちら を参照してください。認識できるキーワードは多数あります。これらのタグは、RAISES_TAGS
のリストにリンクされます。このリストは、 here で見つけることができます。
この情報がお役に立てば幸いです。