使用javadoc获取Python文档

看一下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 unipre:param priority: priority number:type priority: str or unipre:param priority_name: priority name:type priority_name: str or unipre:param message: message to display:type message: str or unipre:returns: formatted string:rtype: str or unipre"""