@paramPython には、やなどの docstring 用のタグがいくつかあります@return。たとえば、次のとおりです。

ジェネレーターのドキュメント化には何を使用できますか? 特に次のyieldようなキーワード:

ここで使用できることは理解してい@return an iteratorますが、ジェネレーターも値を返すことができるため、それが正しいかどうかはわかりません。

ありがとう。

組み込み属性はいつどのように初期化されますか？ __doc__、__name__（私はこれについて知っていると思います:)）、、__class__など__setattr__。

docstringに関する他の質問では、回答の1つに、docstringは単なる単純な文字列であり、を試してみたところ、'すべて機能したとのことでした。しかし、文字列値が割り当てられた変数を使用し、その変数をdocstringの代わりに配置すると、機能しません。そのため、属性はいつ初期化されるのか疑問に思い始めました。""""__doc__

編集：これは私が通訳で試したものです（はい、これはクレイジーで、私は奇妙です：D）

docstring を含む Python スクリプトがあります。コマンドライン引数の解析が成功しない場合、ユーザーの情報として docstring を出力したいと考えています。

これを行う方法はありますか？

最小限の例

ファイルの名前しかない場合、Pythonファイルのドキュメント文字列を取得する方法はありますか？たとえば、a.pyという名前のPythonファイルがあります。私はそれがdoc文字列（以前に義務付けられている）を持っていることを知っていますが、その内部構造、つまりクラスやメインなどがあるかどうかはわかりませんか？かなり明白なことを忘れないことを願っていますそれが主な機能を持っていることを知っていれば、インポートを使用してこの方法でそれを行うことができます

私はそれをこのようにすることはできません：

Pylint は、一部のファイルに docstring がないというエラーをスローします。各クラス、メソッド、および関数にdocstringを追加しようとしましたが、Pylintはファイルの先頭にdocstringが必要であることもチェックしているようです。どういうわけかこれを無効にすることはできますか?

クラス、関数、またはメソッド内で docstring が欠落しているという通知を受け取りたいのですが、ファイルに docstring があることは必須ではありません。

(プロプライエタリなソース ファイルの冒頭によく見られる法律用語の用語はありますか?何か例はありますか?そのような些細な質問を別に投稿してよいかどうかはわかりません。)

これはコードの内容とはまったく関係ないように思われるので、一般的なものにしておきます。

モジュールの 1 つの下部にある最後のクラスに複数行の docstring を追加していました。これは、物事にラベルを追加するものです。Maya のスクリプト エディタを介してモジュールをインポートし、そのクラスでヘルプ(module.Class)を実行すると、このエラーを受け取りました：

複数行の文字列がエラーの原因となっているものを絞り込み、1行または2行で作業するように切り詰めましたが、それ以上は失敗しました。大きな複数行のコメントを別のクラスに移動してヘルプを試みたところ、問題なく機能したため、コメントは問題ではないようでした。次に、モジュールの新しい最後のクラスでヘルプを実行しましたが、失敗しました。終盤に近い位置が問題だったようです。

コメントを失敗したクラスに戻し、そのコードをすべて削除して help() を実行したところ、問題なく動作しました。メソッドを追加し直したところ、コードが 1 行しかない最後のメソッドまで機能しました。私はそのすべての部分を変更しました - 名前を変更し、引数を削除し、コードの 1 行をパスに交換しました - クラスのヘルプは、完全に削除するまで常に失敗しました。ヘルプは module.Class.method で機能したため、メソッド自体とその大きな複数行のコメントは問題ないように見えました。

次に、モジュール ファイル内のクラス全体をその直前のクラスの前に移動しました。ヘルプが機能するようになりました。ただし、ファイルの最後のクラスのヘルプは失敗しましたが、docstring さえありません。クラスを一番下に戻し、最後にあるもので遊んでみました。最後の方法には問題があるようでした。つまり、それらの前に多くのテキストを削除したとしても、最後の 1 つだけを削除するよりも多くのテキストを削除しても、まだ問題が発生します。最後のメソッドに docstring を追加するとヘルプが失敗しましたが、最後の 3 つのメソッドに docstring (単なる「なんでも」) を追加すると、再び機能するようになりました。このすべてが完全に不可解です。

これは、私が何らかの形で見逃した既知の問題ですか? 一部のクラス/メソッド構成は、すべてのメソッド (特に、軽く複雑なもの以上) に docstring がない限り、ヘルプを強制終了する可能性があるようです。

例として小さなコードを追加するための編集:

これは、ファイル内の最終クラスの最終メソッドでした。ヘルプがクラッシュする原因になりました。このメソッドを削除すると、ヘルプが再びクラスで作業できるようになります。ただし、これを残してクラス自体を前のクラスの上に移動すると、このクラスでは再び正常に機能しますが、ファイル内の新しい最終クラスでは失敗し始めます。

コード自体と同じくらい多くのメンテナンスが必要な docstrings を持つ OO 階層があります。例えば、

ここでの問題はAfricanSwallow.airspeed、スーパークラス メソッドの docstring を継承しないことです。テンプレート メソッド パターンを使用して docstring を保持できることはわかっています。つまり、

_ask_arthur各サブクラスに実装します。しかし、ドキュメントストリングを継承する別の方法があるかどうか疑問に思っていました。おそらく、まだ発見していないデコレータですか?

次のコードがあるとします。

そして、それを foo.py として保存しましょう。私が実行すると：

docstring をインデントしようとしました (>>> a = '''...'''。すべてのインデントをチェックしました - 各インデントに 4 つのスペース)。一重引用符を二重引用符に変更しました (>>> a = """.. ..""")、エラーは異なり、doctest はうまくいきません。現在のところ、すべての行を非常に長い文字列に結合し、'\r\n' で区切ることだけが機能します。

私は何かが恋しいですか？

2.7.2 ドキュメントのセクション 6 からModules:

Passing two -O flags to the Python interpreter (-OO) will cause the bytecode compiler to perform optimizations that could in some rare cases result in malfunctioning programs. Currently only __doc__ strings are removed from the bytecode, resulting in more compact .pyo files.

これは私の注意を引きました：

Since some programs may rely on having these available, you should only use this option if you know what you’re doing.

構文エラーを無視して、スクリプトの docstring を削除すると、コードの機能の依存関係やその他の側面が論理的に壊れる可能性がある場合はありますか?

編集

コメントを削除するとヘルプ ステートメントが壊れるのはなぜですか? インタプリタではそうではないようです。

pygtk でラベルを設定すると、ラベルmylabel = gtk.Label("Hello World!")の文字列をmylabel.get()メソッドで取得できます。しかし、Pythonインタープリターでは、このメソッドのdocstringを取得できません: help(gtk.Label.get). 理由を知っている人はいますか？