заголовок — Как правильно комментировать файл PHP на основе источника GNU / GPL
Мой вопрос довольно прост. У меня есть приложение, основанное на другом приложении, поставляемом с лицензией GNU / GPL 2.0 (короче: измененный код, который я предоставлю с той же лицензией и новым именем). Как должен выглядеть мой заголовок php-файлов, чтобы все было нормально (не нарушайте лицензию GNU / GPL 2.0). Пример был бы отличным.
Вот хороший пример:
/**
* @package GovArticle.Administrator
* @subpackage com_govarticle.layouts
* @author Artur Stępień ([email protected])
* @copyright (C) 2005 - 2015 Open Source Matters. All rights reserved.
* @copyright (C) 2015 - Fundacja PCJ Otwarte Źródła
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
* @link http://dostepny.joomla.pl
*
* Based on com_content layouts from Joomla!
*/
(на основе пример файла pear.php.net)
двойной @copyrights это отметить, кто имеет авторские права на оригинальный код. Там может быть также более одного @author теги, чтобы показать, кто является автором оригинального источника (в моем случае не было оригинального автора, просто отметка об авторских правах).
Решение
GNU / GPL 2.0 не требует определенного стиля документации, но рекомендует включать что-то вроде следующего текста в каждый исходный файл:
Этот файл является частью Foobar.
Foobar — это бесплатное программное обеспечение: вы можете распространять его и / или изменять
в соответствии с условиями Стандартной общественной лицензии GNU, опубликованной
Фонд свободного программного обеспечения, либо версия 3 лицензии, либо
(на ваше усмотрение) любая более поздняя версия.Foobar распространяется в надежде, что он будет полезен,
но БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ; даже без подразумеваемой гарантии
УТВЕРЖДАЮЩАЯ ИЛИ ФИТНЕС ДЛЯ ОСОБЕННОЙ ЦЕЛИ. Увидеть
GNU General Public License для более подробной информации.Вы должны были получить копию Стандартной общественной лицензии GNU
вместе с Foobar. Если нет, см. http://www.gnu.org/licenses/.
Вам может не потребоваться такое, как длинное уведомление в каждом файле, см. Уведомления об авторских правах / отказ от ответственности в исходных файлах, и то, что вы показали, может быть достаточно.
Если вы хотите использовать стандартный способ документирования вашего кода, вы можете использовать phpDocumentor (phpDoc).
ГРУША имеет хороший образец файла о том, как вы можете документировать свой код.
РЕДАКТИРОВАТЬ: Вы также должны приписать первоначального автора, если вы используете сторонний GPL-код в вашей собственной программе, см. Комментарий Flosculus ниже.
Другие решения
Других решений пока нет …