PEP257 Python DocStringスタイルのチェッカー
今すぐダウンロード

PEP257 ランキングとまとめ

PEP257 タグ

スタイル Python. DocString. スタイルチェッカー

PEP257 説明

PEP275は、Python Pep 257に準拠をチェックするための静的分析ツールです.http：//www.python.org/dev/peps/pep-0257/。DocStringスタイルをチェックするためのフレームワークは柔軟で、カスタムチェックを簡単に追加できます。たとえば、numpy docString規則をカバーする方法：https：//github.com/numpy/numpy/blob/master/doc/howto_document.rst.txt.Adding新しいチェックは、pep257.pyファイルのdocStringで説明されています.installationUSE PIPまたはEasy_install： PIP Install Pep25755代えて、PEP257.pyのソースファイルを直接使用できます - それは自己完結型です.Pep257はPython 2.4,2.5,2.6,2.7,3.1,3.2です。 ：--h、--helpこのヘルプメッセージを表示して - Exit -e - Exexplain各エラーの説明-r、--range showエラー開始。位置 - q、--quote引用拒否$ Pep257 *。 pydocopt.ppppp：1：0：PEP257モジュールにdocStrings.docopt.ppy:14:4：PEP257クラスのdocStringには1つの空白行があります.docopt.pp：27:0：PEP257エクスポートされたクラスはDocStrings.Docopt.pp：43:4：PEP257エクスポートされた定義にはDocStringsがあります。すべてのモジュールは通常DocStrings.docopt.py:14:4を持っている必要があります。：PEP257クラスのDocStringはそれらの周囲に1の空白行を持つべきです.pep257クラスDocStringは、それらの周りに1つの空白行を持つべきです。クラスを文書化するすべてのDocStrings（1行または複数行）の前後に空白行を挿入します。一般的に言えば、クラスのメソッドは単一の空白行で互いに分離され、DocStringはからオフセットする必要があります。ブランクラインによる最初の方法。対称性については、クラスヘッダーとDocStringの間に空白行を入れます。 Import Sys Import Re＃Python 3互換性試してみてください。 "" Usage-messageの構築中のエラー "" docopt.py:27:0：PEP257エクスポートされたクラスにはdocstringsがあります。クラスパターン（オブジェクト）：DOCOPT.PY：43：4：PEP257エクスポートされた定義にはDOCStringsがあります。 Def Flat（Self）：... Python Appep257 Python APIは、PEP 257のチェックをテストスイートに含める場合に便利です。>>> PEP257.CHECK_FILES（） Pytestスタイルテストは次のようになります。インポートPep257Test_pep257（）：エラー= pep257.check_files（ ）アサートLen（エラー）== 0製品のホームページ

PEP257 関連ソフトウェア