Как правило, рекомендуется добавлять несколько строк с информацией об авторе, версии и лицензии в начало исходных файлов.
Это зависит.Прежде всего, есть два (и более) способа сделать это:
- управление информацией о лицензировании для файла
- управление информацией о лицензировании в центральном местоположении
Если вы начинаете проект с нуля, метод для каждого файла часто прост при сохранении ясности.Как вы пишете, со временем становится все труднее отслеживать вещи.Поэтому все больше и больше проектов переключаются на вариант центрального местоположения.
Преимущество метода «файл за файлом» заключается в том, что объем работы ясен.Зачастую вы пишете название приложения в файле комментария.Если по какой-либо причине вынимается один файл, информация все еще там и цепочка документации не нарушена.
При использовании метода центрального расположения преимущество состоит в том, что это обычно поддерживается вашим программным обеспечением для контроля версий.например ГИТ.Комитеты могут быть подписаны коммитирующим лицом, и автор может быть предоставлен.Документально подтверждено, кто написал, какой код автоматически, и эта информация хранится в центральном месте: VCS.
Сохраните файл COPYING вместе с вашим пакетом, где вы предоставляете основную информацию централизованно.Вы можете легко создать список авторов через VCS.И для каждого файла вы можете создать один заголовок, который просто указывает, какое программное обеспечение и где искать, просто голый контур:
/**
* Flux Deluxe v3.2.0 - Vector Drawing Redefined
*
* Copyright 2010, 2012 by its authors.
* Some rights reserved. See COPYING, AUTHORS.
*/
Если вы выпускаете новую версию в новом году, это не составляет трудаобновить все файлы.