問題タブ [docstring]

それで、いくつかのコードを見て、pylint の助けを借りてそれを PEP 8 標準に引き上げました。テキストが 120 文字を超えた print ステートメントに三重引用符を使用していた場合 (79 文字ではなく 120 文字を許可しています) pylint文句を言いませんでした。
これは pylint のバグですか、それともコメントである可能性があり、行の長さに対してより寛大であると考えていますか、それとも、文字列をそのようにフォーマットしたいので、トリプルクォートで文字列をどこまで使用してもかまいませんか?

明確にするために: はい pylint は、行の長さを超える他のすべてのケースで正常に機能します。

だから私は次のような「動的な」docstringを作成しようとしています：

基本的に、docstringに@param animalType何ANIMAL_TYPESがあるかを表示させます。この変数が更新されると、docstringが自動的に更新されるようにします。

残念ながら、うまくいかないようです。これを達成する方法があるかどうか誰かが知っていますか？

Clojure の複数行のドキュメント文字列は、ほとんどの場合、手動でフォーマットされているように見えることに気付きました。これには、clojure.core のものも含まれます。https://github.com/clojure/clojure/blob/master/src/clj/clojure/core.cljの例:

これは奇妙に思えます。異なる docstring は、手動で維持する必要がある異なる行折り返しの長さなどを持つことを意味するからです。

複数行のdocstringをフォーマットするより良い方法はありますか?

twisted のソースコードでは、多くの docstring に次のような形式が含まれています: L{xxx} や C{xxx}、または '@' で始まる行、それらの意味は何ですか?

たとえば、twisted/internet/interfaces.py では:

L{IPullProducer} 、 C{resumeProducing} 、 @type プロデューサー ?

ところで、これらのフォーマットは標準の python docstring フォーマットの一部ですか? その場合、どこを参照すればよいですか？ありがとう ：）

私はまもなくオープンソースの Python プロジェクトを開始し、docstring の書き方を事前に決めようとしています。明らかな答えは、reStructuredText と Sphinx を と一緒autodocに使用することです。なぜなら、コードを docstring に適切にドキュメント化してから、Sphinx に API ドキュメントを自動的に作成させるというアイデアが本当に好きだからです。

問題は、それが使用する reStructuredText 構文です。レンダリングされる前は完全に判読できないと思います。例えば：

その構文のごちゃまぜから何らかの意味を理解するためには、本当に速度を落として少し時間を割かなければなりません。私は、Google のやり方 ( Google Python Style Guide )の方がずっと好きです。

ずっといい！しかしもちろん、Sphinx にはそれがなく、すべてのテキストArgs:を 1 つの長い行でレンダリングします。

要約すると、この reStructuredText 構文を使用してコード ベースを汚す前に、独自の API ドキュメントを作成する以外に、この reStructuredText 構文と Sphinx を使用する実際の代替手段があるかどうかを知りたいと思います。たとえば、Google スタイル ガイドの docstring スタイルを処理する Sphinx の拡張機能はありますか?

以前に文書化された関数パラメーターをPythondocstringの他の場所で参照したいと思います。次の（明らかに完全に人工的な）例を考えてみましょう。

Sphinxマークアップを使用してパラメーター参照を埋め込む簡単な方法はありますか、それともこれは自動的に行われますか？

（私は完全なSphinx初心者です。Sphinxのドキュメントをスキャンしてきましたが、この質問に対する答えや、適切なマークアップを示す例が見つかりませんでした。）

さらに処理するためにさまざまな部分 (param、return、type、rtype など) を抽出したい Sphinx 形式の docstring があります。どうすればこれを達成できますか？

私は学校向けのScilabプロジェクトを終了しており、ドキュメントのこの一節に基づいて、すべての機能にコメントを追加しました。

関数内では、最初のコメント行から最初の命令まで、または空の行を使用して、関数ヘルプのデフォルトの内容を提供できます。

ただし、help入力してもコメントは表示されませんhelp myfunction。代わりに、検索ページでヘルプブラウザを起動します。

何か案は？基本的に、Matlabの「H1行」と「ヘルプテキスト」に相当するものを探しています。

Python モジュール内のすべての docstring の開始行番号と終了行番号を抽出しようとしています。正規表現なしでこれを行う賢明な方法はありますか?

名前空間内の特定の関数だけでなく、Clojure ライブラリ/名前空間全体にドキュメント文字列やコメントを追加するにはどうすればよいですか?

これを行うために clojure ソース(comment ...)がいくつかの場所で使用されていることに気付きました ( example )。それは推奨されますか?