5

我想在我的 Python 模块的文档字符串中添加一些元信息，例如作者、电子邮件、版本。有没有规范的方法可以做到这一点？我搜索了很长时间，但在此处或网络上找不到任何具有明确权限的内容。

PEP 426——Python 软件包 2.0 的元数据对此进行了一些讨论。它看起来像__author__，__version__并且其他一些被pydoc（V2.7）识别。此外，还有epydoc和sphinx-doc。

是否有一种标准方法可以在文档字符串中包含此类信息？还是作为全局变量？如果是这样，是否有接受的关键字/变量名称列表？

例子：

#########
# Parts
# <description>
#
"""Helper module for selling car parts on the web.
   Author: Sue Baru
   EMail: sb@carparts.com
   Version: 1.0
"""

更新

这不是一个真正的答案，但我最终使用了__author__“关键字”而没有别的。版本控制是通过签入 git repo 来完成的。

4

1 回答 1

0

Sphinx 这样做（使用 reST）：

"""A pypi demonstration vehicle.

.. moduleauthor:: Andrew Carter <andrew@invalid.com>

"""

有关更多信息，请参阅使用 Sphinx 记录您的项目和此备忘单。

于 2013-09-04T23:49:43.707 回答