Использование javadoc для документации по Python [закрыто]

В настоящее время я начинаю с Python и имею большой опыт работы с PHP, а в PHP я привык использовать javadocв качестве шаблона документации.

Мне было интересно, если javadocесть свое место в качестве docstringдокументации в Python. Каковы здесь установленные соглашения и / или официальные правила?

Например, что-то вроде этого слишком сложное, чтобы вписаться в мышление 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)

Взгляните на формат reStructuredText (также известный как «reST»), который является форматом разметки в виде простого текста / строки документа и, вероятно, самым популярным в мире Python. И вам, безусловно, следует взглянуть на Sphinx , инструмент для генерации документации из reStructuredText (используется, например, для самой документации 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 . Обратите внимание, что Sphinx также может анализировать этот формат, используя расширение Napolean , которое будет поставляться в комплекте со Sphinx 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

Пример взят из наполеоновской документации, ссылки на которую приведены выше.

Подробный пример всех типов строк документации здесь .

Стандарт для строк документации 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 '')
    """

Взгляните на Documenting Python , страницу, «предназначенную для авторов и потенциальных авторов документации для Python».

Короче говоря, reStructuredText - это то, что используется для документирования самого Python. Руководство разработчика содержит учебник для начинающих, руководство по стилю и общие рекомендации по написанию хорошей документации.