39

在 python 代码中编写“版权信息”的标准方法是什么?它应该在文档字符串中还是在块注释中?我在 PEP 中找不到它。

4

4 回答 4

37

一些项目使用模块变量__license__,例如:

__author__ = "Software Authors Name"
__copyright__ = "Copyright (C) 2004 Author Name"
__license__ = "Public Domain"
__version__ = "1.0"

对我来说似乎是一个非常干净的解决方案(除非你过度使用并将史诗文本转储到这些变量中),但__version__似乎只是在广泛使用,正如PEP 8中提到的那样。

于 2010-01-12T14:27:32.053 回答
13
# Comment in the beginning of the file

至少 python 内置模块可以做到这一点。(通过做发现grep 'Copyright' /usr/lib64/python2.4/*.py

于 2010-01-12T12:33:15.240 回答
5

我们遵循在软件自由法律中心网站上(某处)找到的建议。是一个简单的 GPL 文件的示例。

于 2010-01-12T13:11:29.157 回答
3

据我所知,目前没有标准的方法。每个公司/组织都有自己的模板来记录版权信息。如果这是您的个人项目,那么请随意以您感觉最舒适的方式进行记录。对于具有许多源文件的项目,添加LICENSE文件是一种非常常见的方式。即使在 Python 中,目前也没有关于文档字符串结构的标准。

Python 提供了很大的自由度,所以就顺其自然吧 ;)

于 2010-01-12T13:12:50.957 回答