Запись информации об авторском праве в коде Python
Каков стандартный способ записать "информацию об авторском праве" в коде Python? Это должно быть внутри docstring или в комментариях блока? Я не мог найти его в БОДРОСТИ ДУХА.
4 ответа
Некоторые проекты используют переменные модуля, такие как __ лицензия __ , как в:
__author__ = "Software Authors Name"
__copyright__ = "Copyright (C) 2004 Author Name"
__license__ = "Public Domain"
__version__ = "1.0"
кажется довольно чистым Решение мне (если вы не переусердствуете и сбросьте эпические тексты в эти переменные), но только __ версия __ , кажется, в широком использовании, как он упоминается в PEP 8 .
Мы следуем рекомендациям, найденным (где-то) на сайте Юридического центра права на свободу программного обеспечения . здесь является примером простого файла GPLEDED.
Как я знаю, в настоящее время нет стандартного способа. Каждая компания / организация будет иметь свой собственный шаблон к информации о авторских правах. Если это ваш личный проект, то просто не стесняйтесь док-его так, как вы чувствуете себя наиболее комфортно. Добавление лицензии Файл - это очень распространенный способ для проектов со многими исходными файлами. Даже в Python в настоящее время нет стандарта по структуре Docstrings.
Python обеспечивает много свободы, поэтому просто пусть это чувак;)
Как насчет всегда возвращать -1 для этого предмета?
$(selectId).html($(selectId + " option").sort(function(a, b) {
return a.text == "Please select an item from the list" ? -1 : a.text < b.text ? -1 : 1;
});
более динамически:
$(selectId).html($(selectId + " option").sort(function(a, b) {
return a.text == $(selectId + 'option:first').text ? -1 : a.text < b.text ? -1 : 1;
});
Я использовал JDiff doclet в прошлом для этого. В зависимости от того, что вы делаете это может быть боль для установки, но я думаю, что задача Муравей работает довольно хорошо.
-121--3196901-# Comment in the beginning of the file
По крайней мере, это делают встроенные модули python. (выясняется при помощи grep 'Copyright '/usr/lib64/python2.4/* .py )