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

14

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

    
pregunta probably at the beach 04.03.2011 - 18:22
fuente

10 respuestas

28

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

  • Tiende a copiarse (sí, mala práctica) ; y termino con personas que me contactan para obtener 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 gente que se comunica conmigo sobre el código que ha cambiado tanto que ni siquiera lo reconozco.

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

    
respondido por el Pascal MARTIN 04.03.2011 - 18:27
fuente
6

Solía tener la costumbre de 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 abandonado ese hábito dado que esto es redundante con el control de versiones, por ejemplo. Cualquier persona interesada en quién hizo qué cambios puede ver el historial completo del código fuente en el control de versiones.

    
respondido por el Brandon 04.03.2011 - 18:27
fuente
5

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

Sin embargo, algunas personas de la comunidad de código abierto encuentran interesante dejar un nombre y una dirección de correo electrónico para el contacto. Esto no es una mala idea en absoluto. Revisa estos ejemplos:

Desde FFmpeg:

/*
 * Interplay C93 video decoder
 * Copyright (c) 2007 Anssi Hannula <anssi.hannula@gmail.com>
 *
 * This file is part of FFmpeg.
 */

Desde 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 <dok@directfb.org>,
              Andreas Hundt <andi@fischlustig.de>,
              Sven Neumann <neo@directfb.org>,
              Ville Syrjälä <syrjala@sci.fi> and
              Claudio Ciccani <klan@users.sf.net>.
*/
    
respondido por el karlphillip 04.03.2011 - 19:45
fuente
3

¿Pero seguramente dejar mi nombre y / o correo electrónico significaría que tenía que escribir comentarios en mi código? Lo siento no fue una respuesta. En realidad, por lo general, dejo los comentarios de doctype ...

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

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

Tengo una firma de correo electrónico que utilizo de vez en cuando y va

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

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 se sienta más cómodo con.

    
respondido por el PurplePilot 04.03.2011 - 20:59
fuente
2

Con frecuencia, dejo mis iniciales en comentarios (cuando corresponda), pero no veo ninguna razón para dejar nada más. Si aún estoy trabajando en la empresa propietaria del código, la gente debería saber cómo contactarme.

Si dejé la empresa y trabajé en otro lugar, no es realmente justo para mi nuevo empleador si atiendo 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, código abierto, publicado en línea), posiblemente valga la pena tener sus datos de contacto, pero si el código se transmitió de otra manera, la persona a quien se lo dio probablemente lo hará. ya tiene sus datos de contacto, ¿y realmente desea que un extraño al azar le pregunte sobre el código que escribió hace años?

    
respondido por el Danny Tuppeny 04.03.2011 - 18:28
fuente
2

Hay una línea de pensamiento que dice: No pongas en tu código fuente cosas que deberían estar en el control de 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 a un nivel inferior al de la granularidad del archivo. Un registro de culpa debe indicarle todo lo que necesita saber.

Dicho esto, muchas empresas siguen la transición de listar el autor del archivo original y nunca cambiarlo. Si es realmente útil (ya que las personas abandonan 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 en el código base de su grupo, obtendrá una idea de las responsabilidades y la experiencia en el proyecto.

Para el dominio público: el beneficio es la "publicidad", el inconveniente es que alguien podría arruinar su archivo en el futuro, pero aún así tendrá su nombre.

    
respondido por el Uri 04.03.2011 - 18:51
fuente
2

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

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

    
respondido por el S.Lott 04.03.2011 - 19:23
fuente
2

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 efecto 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 ingresa su nombre del código, la siguiente persona que ingrese dirá "ese no es mi código, yo solo X", donde X puede piratearlo, ignorarlo, etc. Por supuesto, quieren poner su nombre en el código porque lo mejoraron. Pero entonces puedes pensar, oye, pasé semanas con este código y pasaron 10 minutos, ¿por qué consiguen que su nombre sea el mío? A lo largo del tiempo, este ciclo continúa y la gente discute 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 enfocó en la propiedad colectiva y en hacer que todo el código sea excelente sin propiedad, usted puede enfocarse en lo que es realmente importante, la calidad del sistema. Si necesita averiguar quién ha trabajado en él, siempre puede utilizar 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 está tan activo como otros colaboradores. Por eso, en los proyectos de código abierto, trato de mencionar solo a los autores en un archivo de AUTORES o contribuyentes en un lugar del proyecto.

    
respondido por el Allen 04.03.2011 - 20:17
fuente
1

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

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 código fuente. Dado que el código rara vez se vinculaba desde un VCS y se enviaba más a menudo directamente, si desea recibir comentarios, tendría que incluir su información de contacto en algún lugar.     

respondido por el Chris Browne 04.03.2011 - 22:34
fuente
1

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.

    
respondido por el Cosmin 04.03.2011 - 23:15
fuente

Lea otras preguntas en las etiquetas