Каков стандартный способ написания "информации об авторских правах" в коде python? Должно ли оно находиться внутри docstring или в блочных комментариях? Я не мог найти его в PEP.
Написание информации об авторских правах в коде python
Ответ 1
В некоторых проектах используются переменные модуля, такие как __license__, как в:
__author__ = "Software Authors Name"
__copyright__ = "Copyright (C) 2004 Author Name"
__license__ = "Public Domain"
__version__ = "1.0"
Кажется, это довольно чистое решение для меня (если вы не переусердствовали и не сбрасывали эпические тексты в эти переменные), но только __version__, кажется, широко используется, как упоминается в PEP 8.
Ответ 2
# Comment in the beginning of the file
По крайней мере, встроенные модули python делают это. (выяснено, выполнив grep 'Copyright' /usr/lib64/python2.4/*.py)
Ответ 3
Мы следуем рекомендациям, найденным (где-то) в Юридическом центре Software Freedom сайт. Здесь приведен пример простого файла GPL.
Ответ 4
Как я знаю, в настоящее время нет стандартного способа. Каждая компания/организация будет иметь свой собственный шаблон для документирования информации об авторских правах. Если это ваш личный проект, то просто не стесняйтесь документировать его так, как вы чувствуете себя максимально комфортно. Добавление файла LICENSE является очень распространенным способом для проектов со многими исходными файлами. Даже в Python в настоящее время нет стандарта для структуры docstrings.
Python предоставляет большую свободу, поэтому просто пусть это будет чувак;)