自动管理源文件中的许可证/作者/版本标头

Question

通常认为将一些包含作者,版本和许可证信息的行添加到源文件的顶部是一种好习惯.例如,Gnu GPL v3建议添加

<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This program is free software: you can redistribute it and/or modify
it under the terms [SNIP]

我觉得将它手动添加到每个文件并且不得不一直更新所有这些信息(新作者,版权年份,版本颠簸)时都很繁琐.

有没有办法自动管理这个,所以我只需要在一个地方编辑这些东西,它就会被自动复制？

如果需要,您可以假设我正在使用任何现代版本控制系统.

Answer 1

在源文件的顶部添加一些包含作者、版本和许可证信息的行通常被认为是一种很好的做法。

那要看。首先，有两种（和更多）方法可以做到这一点：

• 管理每个文件的许可信息
• 在中央位置管理许可信息

如果您从头开始一个项目，每个文件的方法通常很容易做到，同时保持清晰。随着您的写作，随着时间的推移，跟踪事物变得更加困难。因此，越来越多的项目切换到中央位置变体。

逐文件方法的好处是工作范围明确。通常您在文件注释中写入应用程序的名称。如果出于某种原因取出单个文件，信息仍然在那里并且文档链没有中断。

使用中央定位方法的好处是，这通常由您的版本控制软件（例如 GIT）支持。提交可以由提交人签名，并且可以给出作者。它记录了谁自动编写了哪些代码，并且该信息存储在一个中央位置：VCS。

在您的包中保留一个 COPYING 文件，您可以在其中集中提供主要信息。您可以通过 VCS 轻松生成作者列表。对于每个文件，您可以创建一个标题，该标题仅指定要查看的软件和位置，只是一个大纲：

/**
 * Flux Deluxe v3.2.0 - Vector Drawing Redefined
 *
 * Copyright 2010, 2012 by its authors. 
 * Some rights reserved. See COPYING, AUTHORS.
 */

如果您在新的一年发布新版本，更新所有文件是轻而易举的事。

Answer 2

使用许可证标题管理器