在python代码中编写“版权信息”的标准方法是什么?它应该在docstring或块注释中吗?我在PEP中找不到它。
答案 0 :(得分:22)
有些项目使用__license__
之类的模块变量,如:
__author__ = "Software Authors Name"
__copyright__ = "Copyright (C) 2004 Author Name"
__license__ = "Public Domain"
__version__ = "1.0"
对我来说似乎是一个非常干净的解决方案(除非你过度使用并将史诗文本转储到这些变量中),但只有__version__
似乎被广泛使用,正如PEP 8中提到的那样。
答案 1 :(得分:12)
# Comment in the beginning of the file
至少python内置模块可以做到这一点。 (通过做grep 'Copyright' /usr/lib64/python2.4/*.py
)
答案 2 :(得分:3)
答案 3 :(得分:2)
据我所知,目前还没有标准方法。每个公司/组织都有自己的模板来记录版权信息。如果这是您的个人项目,那么请随意以您感觉最舒服的方式进行培训。对于包含许多源文件的项目,添加LICENSE
文件是一种非常常见的方式。即使在Python中,目前还没有关于docstrings结构的标准。
Python提供了很多自由,所以只需让它变得粗鲁;)