Gestión automática de encabezado de licencia/autor/versión en archivos de origen

Question

En general, se considera una buena práctica agregar algunas líneas con autor, versión e información de licencia al principio de los archivos fuente. Por ejemplo, GNU GPL v3 sugiere añadir

<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] 

me resulta tedioso para agregarlo manualmente a cada archivo, y tener que actualizar todos ellos de vez en cuando, cuando alguna de esta información cambia (nuevos autores, los derechos de autor años, baches de versión).

¿Hay alguna manera de administrar esto automáticamente, de modo que solo tenga que editar esto en un solo lugar y se copie automágicamente?

Si es necesario, puede suponer que estoy utilizando cualquier sistema de control de revisiones moderno.

Answer 1

En general, se considera una buena práctica agregar algunas líneas con autor, versión e información de licencia a la parte superior de los archivos fuente.

Eso depende. En primer lugar hay dos (o más) formas de hacer esto:

• gestionar la información de licencias por archivo
• gestionar la información de licencia en una ubicación central.

Si inicia un proyecto desde cero, el método por archivo es a menudo fácil de hacer sin dejar las cosas claras. Mientras escribes, con el tiempo cada vez es más difícil hacer un seguimiento de las cosas. Entonces, cada vez más proyectos cambian a la variante de ubicación central.

El método de archivo por archivo tiene la ventaja de que el alcance de un trabajo es claro. A menudo escribes el nombre de la aplicación en el archivo-comentario. Si se saca un solo archivo por alguna razón, la información aún está allí y la cadena de documentación no está rota.

Con el método de ubicación central, la ventaja es que esto normalmente es compatible con su software de control de versiones, por ejemplo, GIT. Los compromisos pueden ser firmados por la persona que realiza la actividad y se puede otorgar el autor. Está documentado quién ha escrito el código automáticamente y esa información se almacena en una ubicación central: el VCS.

Guarde un archivo de COPIA con su paquete donde proporciona la información principal de forma centralizada. Puede generar fácilmente la lista de autores a través del VCS. Y por cada archivo se puede crear una cabecera, que simplemente especifica qué software y dónde buscar en, sólo un esbozo:

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

Si se libera una nueva versión de un nuevo año Es una obviedad para actualizar todos los archivos.

Answer 2

Si trabaja con Visual Studio, puede usar macros y adjuntarle un atajo. Luego, al crear un nuevo archivo, use el atajo para agregar un encabezado. Si quiere asegurarse de que se haya incluido un encabezado en cada archivo, puede usar StyleCop.

siguientes enlaces pueden ser útiles:
http://abhijitjana.net/2010/12/05/add-document-header-for-files-automatically-in-visual-studio/
http://stylecop.codeplex.com/

En Eclipse, también hay soporte de macros lo que debería ser capaz de hacer lo mismo que se proponga para VS. Sin embargo, no tengo ninguna experiencia con eso.

Para Java, hay una alternativa a StyleCop:
http://stylecop.codeplex.com/

no he oído hablar de ningún SVN-herramientas que se adaptan los ficheros por si mismo. Usar macro en su editor es lo más parecido a lo que desea.

Answer 3

Uso del License Header Manager