python - 複数行文字列のインデント

Question

cmd Python モジュールを使用するスクリプトがあります。cmd モジュールは、ヘルプ テキストとして、三重引用符で囲まれた複数行の文字列を使用します。このようなもの

def x(self, strags = None):
    """class
    help text here
    and some more help text here"""

スクリプトを実行すると、コマンド 'help x' によって文字列が出力されます。ただし、最後の 2 行の前にも改行が出力されます。これらの行をインデントしないことでこれを克服できますが、そうするとコードが醜くなります。

このインデントの問題を克服するにはどうすればよいですか? プロの Python コーダーはこれをどのように処理しますか?

Answer 1

個人的には、読者にDocstring Conventions のPEP 257を参照させるPEP 8に従うようにしています。複数行のdocstringに関するセクション全体があります。

Answer 2

次のように、一貫したインデントを使用して処理します。

def x(self, strags = None):
    """
    class
    help text here
    and some more help text here
    """

確かに、2 行多くかかりますが、(私の意見では) doc コメントを非常に目立たせることで、明確さをもたらします。