¿Debemos dejar nuestros datos de contacto en el código fuente?

Por lo general, dejo mi dirección de correo electrónico como cortesía en caso de que alguien quiera hacerme una pregunta más tarde. ¿Otras personas dejan más o menos información que eso? ¿Alguien deja un número de teléfono?

Casi nunca dejo mi nombre ni mi dirección de correo electrónico:

• Tiende a ser pegado (sí, mala práctica) ; y termino con personas que me contactan por un código que no escribí
• Cuando se modifica el código, la información de contacto no se elimina ni se actualiza; y termino con personas que me contactan sobre el código que ha cambiado tanto que ni siquiera lo reconozco.

En cambio, prefiero señalar a las personas al repositorio de código (SVN, Git, ...) : allí, pueden tener el historial completo y averiguar quién escribió / modificó la parte sobre la que tienen una pregunta.

Acostumbro a dejar mi nombre o iniciales en los encabezados de los comentarios, con un número de revisión y una breve descripción del cambio.

Recientemente he dejado ese hábito dado el hecho de que esto es redundante con el control de versiones, por ejemplo, cualquier persona interesada en quién realizó los cambios puede ver todo el historial del código fuente en el control de versiones.

Si está desarrollando software profesionalmente, lo más probable es que esté utilizando algún sistema de control de versiones (svn, hg, git, etc.). En este caso, me parece redundante dejar su información personal dentro del código ya que ya tiene una cuenta codificadora (con esa información) para poder confirmar el código en el proyecto.

Sin embargo, a algunas personas de la comunidad de código abierto les resulta interesante dejar un nombre y una dirección de correo electrónico para contactar. Esta no es una mala idea en absoluto. Mira estos ejemplos:

De FFmpeg:

/*
 * Interplay C93 video decoder
 * Copyright (c) 2007 Anssi Hannula <[email protected]>
 *
 * This file is part of FFmpeg.
 */

De DirectFB:

/*
   (c) Copyright 2001-2009  The world wide DirectFB Open Source Community (directfb.org)
   (c) Copyright 2000-2004  Convergence (integrated media) GmbH

   All rights reserved.

   Written by Denis Oliver Kropp <[email protected]>,
              Andreas Hundt <[email protected]>,
              Sven Neumann <[email protected]>,
              Ville Syrjälä <[email protected]> and
              Claudio Ciccani <[email protected]>.
*/

Pero seguramente dejar mi nombre y / o correo electrónico significaría que se suponía que debía escribir comentarios en mi código. Lo siento, no fue una respuesta. En realidad, generalmente dejo comentarios doctype ...

/**
* @author PurplePilot
* @package
* @etc
*/

con mi nombre pero no mi dirección de correo electrónico. Sí, este código puede cortarse y pegarse, pero si la copiadora no cambia el nombre del autor, no cambiará nada más y resulta obvio que es un comentario no mantenido.

Tengo un correo electrónico que uso de vez en cuando, que va

/* Anything you put in comments is not tested and easily goes out of date. */

lo que parece ser un reflejo general de muchas de las otras publicaciones en este hilo. Sin embargo, como no hay reglas sobre el tema, un programador debe hacer lo que le resulte más cómodo.

A menudo dejo mis iniciales en los comentarios (cuando corresponde), pero no veo ninguna razón para dejar nada más. Si todavía estoy trabajando en la compañía propietaria del código, la gente debería saber cómo ponerse en contacto conmigo.

Si he dejado la empresa y trabajo en otro lugar, no es realmente justo para mi nuevo empleador si estoy recibiendo llamadas sobre software en mi última empresa (¡quién podría ser un competidor!).

Si el código se compartió de alguna otra manera (por ejemplo, de código abierto, publicado en línea), entonces posiblemente valga la pena tener sus datos de contacto, pero si el código se pasó de otra manera, la persona a la que se lo dio probablemente ya tenga su datos de contacto, y ¿realmente querría un extraño al azar llamando preguntando por el código que escribió años antes?

Hay una línea de pensamiento que dice: No pongas en tu código fuente cosas que deberían estar en el control de la fuente.

La información de autoría es una de estas cosas, ya que con el tiempo, el código será modificado por muchas personas con menos de granularidad de archivo. Un registro de culpabilidad debe decirle todo lo que necesita saber.

Dicho esto, muchas compañías siguen la transición de enumerar el autor del archivo original y nunca lo cambian. Si es realmente útil (cuando la gente deja las empresas), no lo sé.

Sospecho que el valor principal es crear conciencia. No irá y le pedirá al IDE que le diga quién es el autor de cada archivo que ve, pero al encontrarlos con el tiempo en la base de código de su grupo, obtiene una idea de las responsabilidades y la experiencia en el proyecto.

Para el dominio público: el beneficio es la "publicidad", la desventaja es que alguien podría destruir su archivo en el futuro, pero aún estaría con su nombre.

Después de 3 décadas de programación y mantenimiento y conversión de software, puedo decir con seguridad que la información del autor en el código fuente no tiene valor.

Nunca he tenido un uso para ello. No se puede confiar. Ninguna de las personas sigue empleada por la empresa. La mitad de los nombres son contratistas.

Nunca dejo mis datos de contacto en el código. Siempre se desactualiza y parece causar más problemas de los que resuelve.

Otras personas han señalado algunos de los problemas, pero quería mencionar uno que creo que es el más insidioso.

Puede destruir el trabajo en equipo y la calidad del código.

Cómo puede preguntar, bueno, todo tiene que ver con la propiedad del código colectivo. Si pones tu nombre del código, la siguiente persona que ingrese dirá "ese no es mi código, solo voy a X" donde X puede ser pirateado, ignorarlo, etc. Luego, si lo arreglan, ellos por supuesto, quieren poner su nombre en el código porque lo mejoraron. Pero entonces puedes pensar, hey, pasé semanas en este código y pasaron 10 minutos, ¿por qué tienen su nombre junto al mío? Con el tiempo, este ciclo continúa y las personas discuten sobre quién debería obtener crédito (o culpa) por el código.

Simplemente no funciona bien para el equipo. En cambio, si el equipo se centró en la propiedad colectiva y en hacer que todo el código sea excelente sin propiedad, puede concentrarse en lo que es realmente importante: la calidad del sistema. Si necesita localizar quién ha trabajado en él, siempre puede usar el VCS para obtener los detalles.

Nota: Incluso los encabezados de copyright pueden tener este impacto destructivo si tiene el nombre de un desarrollador, especialmente si el desarrollador no es tan activo como otros contribuyentes. Es por eso que en los proyectos de código abierto trato de mencionar solo a los autores en un archivo de AUTORES o colaboradores en un lugar del proyecto.

No tiendo a dejar mi información de contacto en el código fuente ya que mi VCS se encarga de la responsabilidad por mí.

Dicho esto, es recomendable tener su información de contacto en algún lugar para que las personas que usan el código puedan contactarlo directamente para brindarle sus comentarios. Un enlace a un sitio web del proyecto en el archivo README es generalmente una buena práctica.

La convención proviene de la época en que Usenet e IRC se usaban regularmente para compartir el código fuente. Dado que el código rara vez se vinculaba desde un VCS y con mayor frecuencia se enviaba directamente, si deseaba comentarios, tendría que incluir su información de contacto en algún lugar.

Dejo mi nombre en los scripts SQL, ya que en su mayoría se obtendrán directamente de la base de datos, no del control de origen.