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

Closed . Этот вопрос основан на мнении . В настоящее время он не принимает ответы.

Хотите улучшить этот вопрос? Обновите вопрос, чтобы на него можно было ответить с помощью фактов и цитат, редактируя это сообщение .

Закрыт в прошлом году .

В настоящее время я начинаю работать с 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
"""

И если я слишком исчерпывающе, если я должен использовать что-то вроде этого (где большая часть документации не t распечатать с помощью метода __ 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)

158

задан ivan_pozdeev 28 November 2018 в 09:38

0 ответов

Другие вопросы по тегам:

python documentation javadoc docstring

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

0 ответов

Похожие вопросы: