問題タブ [docstring]

「prop」という名前のクラス プロパティを持つ以下に定義されたクラスがあり、「これはプロパティ コメントです」というドキュメント文字列を出力したいと考えています。現在の動作は、プロパティの getter を実行し、'getter' を出力します。

「help(MyClass.prop)」と入力してdocstringを取得できるように、クラスとそのメタクラスをセットアップする方法はありますか?

pep8のようなツールはソース コード スタイルをチェックできますが、ドキュメント文字列がpep257、pep287に従ってフォーマットされているかどうかはチェックしません。そのようなツールはありますか？

アップデート

このような静的分析ツールを自分で実装することにしました。次を参照してください。

https://github.com/GreenSteam/pep257

現在、ほとんどのpep257がカバーされています。設計は、前述の pep8ツールの影響を強く受けています。

help()検索する フィールドのデフォルト値を読み込んで割り当てるために、次のスクリプトを作成しました。

それを行うためのよりpythonicな方法はありますか？それは良い考えですか？ help()提供されていない場合でも、正しいメタデータを出力できるようになりました。

コードに関するコメントも大歓迎です。

関数自体の内部から Python 関数のドキュメント文字列を出力したいと考えています。たとえば。

現時点では、my_function定義された直後にこれを行っています。

しかし、関数自体にこれをさせたいと思います。

my_function 内で呼び出してみprint self.__doc__ print self.my_function.__doc__ましたが、うまくいきませんでした。print this.__doc__

自動 PEP8 準拠を取得するために、コード セクションの自動入力を 79 列、ドキュメント文字列の自動入力を 72 に設定したいと考えています。Lisp モード (emacs-lisp-docstring-fill-column) ではこれを行うオプションがあるようですが、Python ではそうではありません。

これを含む拡張された python-mode.el はどこかにありますか?

次のように入力すると、IPython に reStructuredText (Sphinx 用) docstring を完全にレンダリングさせる方法はありますか?

また：

生のマークアップが表示されているときに、IPython でヘルプ ドキュメントを読もうとすると、非常に気が散ってしまいます。reST は Sphinx のドキュメントには最適ですが、単純なヘルプ検索は本当に雑然としています。これは一人じゃいられない…？

Googleはこれについて何の助けにもなりませんでした。

AST でモジュール レベルのドキュメント文字列を解析することは可能ですか?

私はここでpythonドキュメンターに取り組んでおり、モジュールトークンにアクセスしてドキュメントを取得しても、モジュールレベルのdocstringは得られません。これまでのところ、モジュールをインポートして取得するか、ドキュメントを取得するために__doc__使用する必要がありました。inspect

pydoc モジュールのソースを調べて、他のドキュメンターが docstring を解析する方法の手がかりを探したところ、モジュール レベルの文字列を取得するために、pydoc が私のドキュメンターと基本的に同じことをしなければならないことがわかりました。

何か不足していますか？モジュールを実際にインポートしてモジュールレベルのdocstringを解析する唯一の方法ですか、それともASTから直接docstringを解析することは可能ですか?

コードを考えてみましょう：

すべてのプロパティにdoc-stringを追加したいと思います。だから、私は（ファイルプロパティのために）次のようなことをすることができます：

ただし、プロパティごとにgetter、setter、deleterメソッドを作成するのは面倒です。実際、これらのメソッド（上記のように）はデフォルトの仕事をします。

プロパティにdoc-stringのみを追加する簡単な方法はありますか？

いくつかの python ファイルから docstring を解析する必要があり、これを Javascript で行う必要があります。

これに関する参考文献が見つかりませんでした。アイデアはありますか?

編集:Titanium SDK と jquery を使用しています。PyDoc は私が探しているソリューションではありません。javascript と python ソース コードの途中にプロセスを含めたくないからです。

編集 2: 解決済み - Titanium は python と javascript を同時に使用できるため、python を使用して python ファイルから docstring を解析できます。

私が書いたパッケージにいくつかの（epydoc）ドキュメントを追加していますが、何度も繰り返している場合がたくさんあります。

PEP257は次のように述べています。

ワンライナーは本当に明白なケースのためのものです。

そしてまた

関数またはメソッドのdocstringは、その動作を要約し、引数、戻り値、副作用、発生した例外、および呼び出すことができる場合の制限（該当する場合はすべて）を文書化する必要があります。

ワンライナー（説明）フィールドと完全なパラメーター/リターンフィールドの間に線を引くタイミングに関する一般的なガイドラインまたは標準的な方法はありますか？

または、ドキュメントを生成するときに、反復性に関係なく、各関数に適用可能なすべてのフィールドを含める必要がありますか？

ボーナスの質問：構文的に、scriptパラメータを説明するための最良の方法は何ですか？