Pythonドキュメントでのjavadocの使用[終了]

私は現在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
#    
# @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

def format(self, timestamp = '', priority = '', priority_name = '', message = ''):
    """
    replaces template place holder with values
    """
    values = {'%timestamp%' : timestamp,
              '%priorityName%' : priority_name,
              '%priority%' : priority,
              '%message%' : message}

    return self.__pattern.format(**values)

プレーンテキスト/ドキュメント文字列のマークアップ形式であり、おそらくPythonの世界で最も人気のあるreStructuredText（「reST」とも呼ばれます）形式をご覧ください。そして、確かにreStructuredTextからドキュメントを生成するためのツールであるSphinxを確認する必要があります（たとえば、Pythonドキュメント自体に使用されます）。Sphinxには、コード内のドキュメント文字列からドキュメントを抽出する機能が含まれ（sphinx.ext.autodocを参照）、特定の規則に従ってreST フィールドリストを認識します。これはおそらく、最も一般的な方法になっています（またはそうなっています）。

あなたの例は次のようになります：

"""Replaces template placeholder with values.

:param timestamp: formatted date to display
:param priority: priority number
:param priority_name: priority name
:param message: message to display
:returns: formatted string
"""

またはタイプ情報で拡張：

"""Replaces template placeholder with values.

:param timestamp: formatted date to display
:type timestamp: str or unicode
:param priority: priority number
:type priority: str or unicode
:param priority_name: priority name
:type priority_name: str or unicode
:param message: message to display
:type message: str or unicode
:returns: formatted string
:rtype: str or unicode
"""

Google Python Style Guideに従ってください。スフィンクスも使用してこのフォーマットを解析することができることに留意されたいナポレオンスフィンクス1.3とともにパッケージ来る拡張を、（これもと互換性のあるPEP257）。

def func(arg1, arg2):
    """Summary line.

    Extended description of function.

    Args:
        arg1 (int): Description of arg1
        arg2 (str): Description of arg2

    Returns:
        bool: Description of return value

    """
    return True

上記のリンクにあるナポレオンのドキュメントからの例。

ここでは、すべてのタイプのdocstringに関する包括的な例を示します。

Pythonドキュメント文字列の標準については、Python拡張提案257で説明されています。

あなたの方法に適切なコメントは次のようになります

def format(...):
    """Return timestamp string with place holders replaced with values.

    Keyword arguments:
    timestamp     -- the format string (default '')
    priority      -- priority number (default '')
    priority_name -- priority name (default '')
    message       -- message to display (default '')
    """

「Pythonのドキュメントの作成者および潜在的な作成者を対象としたページ」であるDocumenting Pythonをご覧ください。

要するに、reStructuredTextはPython自体を文書化するために使用されるものです。開発者用ガイドには、reST入門書、スタイルガイド、および優れたドキュメントを作成するための一般的なアドバイスが含まれています。