Utilizzo di javadoc per la documentazione di Python [chiuso]

Attualmente sto iniziando con Python e ho un forte background in PHP e in PHP ho preso l'abitudine di usarlo javadoccome modello di documentazione.

Mi chiedevo se javadocha il suo posto come docstringdocumentazione in Python. Quali sono le convenzioni stabilite e / o le corporazioni ufficiali qui?

Ad esempio, qualcosa del genere è troppo elaborato per adattarsi alla mentalità di Python o dovrei cercare di essere il più conciso possibile?

"""
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
"""

E se sono un po 'troppo esaustivo, dovrei scegliere qualcosa del genere (dove la maggior parte della documentazione non viene stampata con il __doc__metodo)?

# 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)

Dai un'occhiata al formato reStructuredText (noto anche come "reST"), che è un formato di markup in testo normale / docstring e probabilmente il più popolare nel mondo Python. E dovresti certamente guardare a Sphinx , uno strumento per generare documentazione da reStructuredText (usato per esempio la stessa documentazione di Python). Sphinx include la possibilità di estrarre documentazione dai documenti nel proprio codice (vedere sphinx.ext.autodoc ) e riconosce gli elenchi dei campi reST a seguito di determinate convenzioni. Questo è probabilmente diventato (o sta diventando) il modo più popolare per farlo.

Il tuo esempio potrebbe apparire come segue:

"""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
"""

O esteso con le informazioni sul tipo:

"""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
"""

Segui la Guida allo stile di Google Python . Nota che Sphinx può anche analizzare questo formato usando l' estensione Napolean , che verrà fornita in pacchetto con Sphinx 1.3 (questo è anche compatibile con 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

Esempio tratto dalla documentazione napoletana collegata sopra.

Un esempio completo su tutti i tipi di dotstring qui .

Lo standard per le stringhe di documentazione di Python è descritto nella proposta 257 di Python Enhancement .

Il commento appropriato per il tuo metodo sarebbe qualcosa di simile

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 '')
    """

Dai un'occhiata a Documenting Python , una pagina "rivolta ad autori e potenziali autori di documentazione per Python".

In breve, reStructuredText è ciò che viene utilizzato per documentare Python stesso. La guida per lo sviluppatore contiene un primer reST, una guida di stile e consigli generali per scrivere una buona documentazione.