我想在我的Python模块的文档字符串中添加一些元信息,例如作者,电子邮件,版本。有没有规范的方法呢?我搜索了很长一段时间,但在这里或网上找不到具有明确权威的东西。
PEP 426 -- Metadata for Python Software Packages 2.0谈论它。它看起来像__author__
,__version__
,而其他一些则被pydoc
(V2.7)识别。此外,还有epydoc
和sphinx-doc
。
是否有标准方法在docstring中包含此类信息?还是作为全局变量?如果是,是否有已接受的关键字/变量名称列表?
示例:
#########
# Parts
# <description>
#
"""Helper module for selling car parts on the web.
Author: Sue Baru
EMail: sb@carparts.com
Version: 1.0
"""
更新
这不是一个真正的答案,但我最终使用了__author__
'关键字'而没有其他任何内容。通过检入git repo来完成版本控制。
答案 0 :(得分:0)
Sphinx这样做(使用reST):
"""A pypi demonstration vehicle.
.. moduleauthor:: Andrew Carter <andrew@invalid.com>
"""
有关详情,请参阅Documenting Your Project Using Sphinx和this cheatsheet。