¿Cómo realiza un seguimiento de los autores del código? [cerrado]

Esto es algo que nunca me enseñaron. He visto muchos tipos diferentes de estilos de autoría. Codifico principalmente en Java y Python. Me preguntaba si había un estilo de autor estándar o si todo es estilo libre. Además, si responde, ¿le importaría adjuntar el estilo que usa a los archivos de autor que crea en su hogar o en el trabajo?

Por lo general solo voy

@author garbagecollector
@company garbage inc.

No estoy completamente seguro de lo que está preguntando, sin embargo, uso un estilo muy estricto:

;==========================================
; Title:  Author Style Sample
; Author: Darknite
; Date:   7 Jan 2011
;==========================================

El estilo está inspirado en los programadores de ensamblaje.

Puse esto en la parte superior de las páginas que necesito para "Autorizar", independientemente de si se trata de una clase, un archivo de texto o un procedimiento almacenado de SQL, etc.

¿Por que lo harias? ese es el trabajo del sistema de versiones y "Culpa" :)

No hacemos autoría en mi empresa. En cambio, dejamos que nuestro control de versiones lo maneje.

Cada vez que se registra, adjunta su nombre de usuario a la lista de cambios. Si algo se rompe, alguien puede regresar y mirar el historial de cambios para ver qué ha cambiado, cuándo y quién lo hizo. También es bueno mirar el gráfico de revisión para ver cómo ha evolucionado un archivo con el tiempo, quién lo tocó, qué proyectos se han ramificado a partir de él.

El problema que veo al poner una etiqueta de autor en una clase es que con el tiempo es muy probable que más de un desarrollador trabaje en esa clase. Actualizaciones, y similares. Es un paso adicional para actualizar ese comentario del autor, y los pasos pequeños adicionales tienden a olvidarse mucho. Por lo tanto, se desactualiza rápidamente.

Yo no hago eso en absoluto. Creo que en el trabajo tenemos una plantilla que se inserta en los archivos con el nombre de la empresa y el ID de usuario de la persona que modificó el archivo por última vez, pero nunca le presto atención.

En general, no creo que realmente importe cómo lo haces. Si desea crear un sello de autor en sus archivos, simplemente elija un estilo consistente y vaya con él.

JavaDoc es muy estándar en la comunidad Java:

http://download.oracle.com/javase/1.3/docs/tooldocs/win32/javadoc.html#@author

@author nombre-texto

Agrega una entrada "Autor" con el nombre-texto especificado a los documentos generados cuando se usa la opción -author. Un comentario de documento puede contener varias @authoretiquetas. Puede especificar un nombre por @authoretiqueta o varios nombres por etiqueta. En el primer caso, Javadoc inserta una coma (,) y un espacio entre los nombres. En el último caso, todo el texto simplemente se copia al documento generado sin ser analizado. Por lo tanto, use varios nombres por línea si desea un separador de nombre localizado diferente de la coma.

Creo que es mejor dejarlo al sistema de control de versiones.

Me gusta la función de culpa en GIT. Puede ver quién creó cada pieza / línea de código. No solo un archivo.

Si está trabajando en un proyecto grande con muchos colaboradores, anotar cada archivo con una lista de autores simplemente no funciona. ¿Qué hace con la lista de autores cuando divide un archivo en varios archivos más pequeños? ¿Mantiene el nombre del autor original si reescribe completamente el código? ¿Agrega su nombre a la lista de autores cuando corrige un error tipográfico en el comentario?

Es mejor dejar estas preguntas para el sistema de control de versiones.

Pero no estoy completamente en contra de la lista de autores. Mantener una lista de autores para todo el proyecto tiene mucho sentido. Si se trata de un proyecto de un solo archivo, seguro, manténgalo dentro de ese mismo archivo. Si es un proyecto más grande, manténgalo en README o en su archivo fuente de nivel superior (también conocido como main.c). Pero no se repita enumerando autores en cada archivo.

Realizamos un seguimiento utilizando el sistema de control de versiones o colocando @authorel código. Otra forma de hacerlo es decir, en general, que ciertas personas fueron autores de módulos completos o de todo el programa. Eso alienta a las personas a pensar en sí mismas como parte de un equipo en lugar de como un engranaje en la máquina responsable de exactamente X número de funciones o líneas de código.

Yo uso Doxygen estilo (o, a veces KernelDoc) comentarios para prácticamente todo. Principalmente trabajo en C y PHP, donde Doxygen es bastante popular.

En la mayoría de los casos, es útil incluir al menos la siguiente información:

• Permiso (o no) para copiarlo / Copyright de la empresa o individuo
• Nombre del autor / correo electrónico
• Fecha escrita
• Fecha de última modificación

Eso debería ayudar a cualquiera que esté trabajando en el archivo a saber qué tienen, qué pueden hacer con él y a quién pueden pedir ayuda si la necesitan. También les dice si están mirando algo de 10 años.

Yo personalmente no hago esto porque es documentación adicional que, como otros dijeron, está en el control de versiones. Pero si fuera a hacer algún tipo de fragmento de código de kung-fu, probablemente sería apto para cualquier cosa que mi IDE fuera capaz de generar automáticamente.

Por ejemplo, al usar en Delphi 7 con esos útiles CNTools instalados, escribo

///a [enter]

y sale

//<author></author>

entonces escribo

///d [enter]

y sale

 //<date></date>

Me imagino que corresponde a algo que una utilidad de terceros puede detectar, pero en cuanto a mí, tengo un estándar que ni siquiera tuve que inventar y corromper.