タグ付けされた質問 「docstring」

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 Pythonでdocstringsを書くいくつかの異なるスタイルを見てきましたが、公式または「合意された」スタイルはありますか？

888 python  coding-style  documentation  docstring 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する 私は現在Pythonから始めており、PHPのバックグラウンドが高く、PHPではjavadocドキュメントテンプレートとして使用する習慣をつけています。 Pythonのドキュメンテーションjavadocとしての場所があるのか​​と思っていましたdocstring。ここで確立された規則および/または公式のガイドラインは何ですか？ たとえば、Pythonの考え方に合わせるには手の込んだようなものですか、できる限り簡潔にしようとする必要がありますか？ """ replaces template place holder with values @param string timestamp formatted date to display @param string priority priority number @param string priority_name priority name @param string message message to display @return string formatted string """ そして、もし私が少し余りに網羅的であるなら、代わりにこのようなものを使うべきです（ほとんどのドキュメントは__doc__メソッドを通じて印刷されません）？ # replaces template place holder with values …

162 python  documentation  javadoc  docstring 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する 私は、その属性がパブリックにアクセスできるように意図され、特定のインスタンス化で時々オーバーライドされるだけの軽量クラスを書いています。Python属性には、クラス属性のdocstringや、あらゆる種類の属性を作成するための規定はありません。これらの属性を文書化するために期待され、サポートされている方法は何ですか？現在、私はこのようなことをしています： class Albatross(object): """A bird with a flight speed exceeding that of an unladen swallow. Attributes: """ flight_speed = 691 __doc__ += """ flight_speed (691) The maximum speed that such a bird can attain. """ nesting_grounds = "Raymond Luxury-Yacht" __doc__ += """ nesting_grounds ("Raymond Luxury-Yacht") The …

115 python  class  documentation  docstring  class-attributes 

クローズ。この質問はもっと焦点を合わせる必要があります。現在、回答を受け付けていません。 この質問を改善したいですか？質問を更新して、この投稿を編集するだけで1つの問題に焦点を当てるようにします。 2年前に閉鎖されました。 この質問を改善する 私はDoxygenがCまたはPHPコードのドキュメントを作成するのが好きです。私は今後のPythonプロジェクトを持っていますが、Pythonには/* .. */コメントがなく、Pythonのように文書化する独自の自己文書化機能もあることを覚えていると思います。 私はDoxygenに精通しているので、それを使用してPythonドキュメントを作成するにはどうすればよいですか？特に気をつけなければならないことはありますか？

94 python  documentation  doxygen  docstring  python-sphinx 

簡単な方法で名前付きタプルにドキュメント文字列を追加することは可能ですか？ 私は試した from collections import namedtuple Point = namedtuple("Point", ["x", "y"]) """ A point in 2D space """ # Yet another test """ A(nother) point in 2D space """ Point2 = namedtuple("Point2", ["x", "y"]) print Point.__doc__ # -> "Point(x, y)" print Point2.__doc__ # -> "Point2(x, y)" しかし、それはそれをカットしません。他の方法で行うことは可能ですか？

85 python  docstring  namedtuple