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

13

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 existía un estilo de creación estándar o si todo es estilo libre. Además, si responde, ¿le importaría agregar el estilo que usa para crear archivos que cree en su casa o en el trabajo?

Por lo general, sólo voy

@author garbagecollector
@company garbage inc.
    
pregunta dustyprogrammer 07.01.2011 - 15:21

11 respuestas

-1

No estoy completamente seguro de lo que preguntas, pero uso un estilo muy estricto:

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

El estilo está inspirado en los programadores de ensamblajes.

Pongo 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.

No sé si eso ayuda.

    
respondido por el Darknight 07.01.2011 - 15:27
68

¿Por qué lo harías? ese es el trabajo del sistema de versiones y "culpa" :)

    
respondido por el Homde 07.01.2011 - 15:36
11

No hacemos autoría en mi empresa. En su lugar, 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 agradable mirar el gráfico de revisión para ver cómo ha evolucionado un archivo a lo largo del tiempo, quién lo ha tocado y qué proyectos se han ramificado.

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 esté trabajando en esa clase. Actualizaciones, y similares. Es un paso adicional para actualizar el comentario del autor, y los pasos pequeños tienden a olvidarse mucho. Por lo tanto, se desactualiza rápidamente.

    
respondido por el Tyanna 07.01.2011 - 16:42
10

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 sellar sus archivos de autor, simplemente elija un estilo coherente y sígalo.

    
respondido por el Adam Lear 07.01.2011 - 15:25
6

JavaDoc es muy estándar en la comunidad de Java:

enlace

  

@author name-text

     

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

    
respondido por el Luca Matteis 07.01.2011 - 15:31
5

Creo que es mejor dejarlo en el sistema de control de versiones.

    
respondido por el Tundey 07.01.2011 - 18:10
4

Me gusta la función culpar en GIT. Puedes ver quién es el autor de cada pieza / línea de código. No sólo un archivo.

    
respondido por el chiurox 07.01.2011 - 20:08
1

Si está trabajando en un proyecto grande con muchos colaboradores, la anotación de cada archivo con la 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 original del autor si reescribe completamente el código? ¿Agrega su nombre a la lista de autores cuando corrige un error tipográfico en un 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 archivo único, claro, 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 a los autores en cada archivo.

    
respondido por el Rene Saarsoo 07.01.2011 - 16:32
1

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

respondido por el Rudolf Olah 07.01.2011 - 20:00
0

Uso Doxygen (o, a veces, KernelDoc) comentarios para casi 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 / Derechos de autor de la empresa o individuo
  • Nombre del autor / correo electrónico
  • fecha escrita
  • Fecha de la última modificación

Eso debería ayudar a cualquier persona que esté trabajando en el archivo a saber qué tiene, qué puede hacer con él y a quién puede pedirle ayuda si la necesita. También les dice si están viendo algo de 10 años.

    
respondido por el Tim Post 07.01.2011 - 15:45
0

Yo personalmente no hago esto porque es una documentación adicional que, como han dicho otros, está en el control de versiones. Pero si fuera a hacer algún tipo de fragmento de código de kung-fu, probablemente iría con 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>

luego escribo

///d [enter]

y sale

 //<date></date>

Me imagino que eso corresponde a algo que una utilidad de un tercero puede detectar, pero en lo que a mí respecta, tengo un estándar que ni siquiera tuve que recuperar y corromperme.

    
respondido por el Peter Turner 07.01.2011 - 18:28

Lea otras preguntas en las etiquetas