Dovremmo lasciare i nostri dati di contatto nel codice sorgente?

Di solito lascio il mio indirizzo e-mail come cortesia nel caso in cui qualcuno voglia farmi una domanda al riguardo. Altre persone lasciano più o meno informazioni di così? Qualcuno lascia un numero di telefono ??

Non lascio quasi mai il mio nome né l'indirizzo e-mail:

• Tende a essere incollato (sì, cattiva pratica) ; e finisco con le persone che mi contattano per il codice che non ho scritto
• Quando il codice viene modificato, le informazioni di contatto non vengono rimosse né aggiornate; e finisco con le persone che mi contattano sul codice che è cambiato così tanto che non lo riconosco nemmeno.

Invece, preferisco indirizzare le persone al repository di codice (SVN, Git, ...) : lì, possono avere la cronologia completa - e scoprire chi ha scritto / modificato la parte di cui hanno una domanda.

Ho l'abitudine di lasciare il mio nome o le iniziali nelle intestazioni dei commenti, con un numero di revisione e una breve descrizione della modifica.

Recentemente sono uscito da quell'abitudine dato il fatto che questo è ridondante con il controllo della versione, ad esempio chiunque sia interessato a chi ha apportato le modifiche può vedere l'intera cronologia del codice sorgente nel controllo della versione.

Se stai sviluppando software in modo professionale, molto probabilmente stai usando un sistema di controllo della versione (svn, hg, git, ecc.). In questo caso, trovo ridondante lasciare le tue informazioni personali all'interno del codice poiché hai già un account programmatore (con tali informazioni) per poter eseguire il commit del codice sul progetto.

Tuttavia, alcune persone della comunità open source trovano interessante lasciare un nome e un indirizzo e-mail per il contatto. Questa non è affatto una cattiva idea. Dai un'occhiata a questi esempi:

Da FFmpeg:

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

Da 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>.
*/

Ma sicuramente lasciare il mio nome o e-mail significherebbe che avrei dovuto scrivere commenti nel mio codice ?? Scusa non è stata una risposta. In realtà di solito lascio commenti doctype ...

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

con il mio nome ma non con l'indirizzo e-mail. Sì, questo codice può essere tagliato e incollato ma se la fotocopiatrice non cambia il nome dell'autore non cambierà nient'altro e diventa ovvio che si tratta di un commento non mantenuto.

Di tanto in tanto ho un indirizzo e-mail che utilizzo

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

che sembra essere un riflesso generale di molti altri post in questa discussione. Tuttavia, poiché non esistono regole in materia, un programmatore deve fare ciò che ritiene più comodo.

Lascio spesso le mie iniziali nei commenti (se del caso), ma non vedo alcun motivo per lasciare altro. Se sto ancora lavorando presso la società proprietaria del codice, le persone dovrebbero sapere come mettersi in contatto con me.

Se ho lasciato l'azienda e ho lavorato altrove, non è proprio giusto per il mio nuovo datore di lavoro se sto rispondendo al software della mia ultima azienda (chi potrebbe essere un concorrente!).

Se il codice è stato condiviso in altro modo (ad es. Open-source, pubblicato online), probabilmente vale la pena avere i tuoi dati di contatto, ma se il codice è stato passato in un altro modo, la persona a cui lo hai fornito probabilmente avrà già il tuo i dettagli di contatto e vorresti davvero che uno sconosciuto a caso ti chiedesse del codice che hai scritto anni prima?

C'è una linea di pensiero che dice: non mettere nel tuo codice sorgente cose che dovrebbero essere nel controllo del codice sorgente.

Le informazioni sull'autore sono una di queste cose, poiché nel tempo il codice verrà modificato da molte persone con una granularità inferiore ai file. Un registro delle colpe dovrebbe dirti tutto ciò che devi sapere.

Detto questo, molte aziende seguono la transizione di elencare l'autore del file originale e non cambiarlo mai. Se sia davvero utile (dato che le persone lasciano le aziende), non lo so.

Sospetto che il valore principale sia costruire consapevolezza. Non andrai a chiedere all'IDE di dirti chi ha creato ciascun file che vedi, ma incontrandoli nel tempo nella base di codice del tuo gruppo, avrai un'idea delle responsabilità e delle competenze nel progetto.

Per il pubblico dominio - il vantaggio è la "pubblicità", il rovescio della medaglia è che qualcuno potrebbe rovinare il tuo file in futuro, ma avrebbe comunque il tuo nome.

Dopo 3 decenni di programmazione, manutenzione e conversione di software, posso tranquillamente dire che le informazioni sull'autore nel codice sorgente sono prive di valore.

Non ne ho mai avuto bisogno. Non ci si può fidare. Nessuna delle persone è ancora impiegata dall'azienda. La metà dei nomi sono appaltatori.

Non lascio mai i miei dati di contatto nel codice. Diventa sempre obsoleto e sembra causare più problemi di quanti ne risolva.

Altre persone hanno sottolineato alcuni dei problemi, ma volevo menzionarne uno che penso sia l'effetto più insidioso.

Può distruggere il lavoro di gruppo e la qualità del codice.

Come si può chiedere, tutto ha a che fare con la proprietà del codice collettivo. Se inserisci il tuo nome del codice, la prossima persona che entrerà dirà "che non è il mio codice, io solo X" dove X può essere hackerato, ignorarlo, ecc. Quindi se lo risolvono, loro ovviamente vogliono mettere il loro nome sul codice perché lo hanno migliorato. Ma poi potresti pensare, ehi ho trascorso settimane su questo codice e hanno trascorso 10 minuti perché ottengono il loro nome proprio dal mio. Nel tempo questo ciclo continua e le persone discutono su chi dovrebbe ottenere credito (o colpa) per il codice.

Semplicemente non funziona bene per la squadra. Invece se il team si concentrava sulla proprietà collettiva e sull'ottimizzazione di tutto il codice senza alcuna proprietà, puoi concentrarti su ciò che è veramente importante, ovvero la qualità del sistema. Se hai bisogno di rintracciare chi ci ha lavorato, puoi sempre usare il VCS per ottenere i dettagli.

Nota: anche le intestazioni del copyright possono avere questo impatto distruttivo se hanno il nome di uno sviluppatore, specialmente se lo sviluppatore non è attivo come altri collaboratori. Ecco perché nei progetti Open Source provo a menzionare gli autori in un file AUTORI o collaboratori un posto nel progetto.

Non tendo a lasciare le mie informazioni di contatto nel codice sorgente poiché il mio VCS si occupa della responsabilità per me.

Detto questo, è consigliabile avere le informazioni di contatto da qualche parte modo che le persone che usano il codice possano contattarti direttamente per fornire feedback. Un collegamento a un sito Web del progetto nel file README è generalmente una buona pratica.

La convenzione viene dall'epoca in cui Usenet e IRC venivano usati regolarmente per condividere il codice sorgente. Poiché il codice è stato raramente collegato da un VCS e più spesso inviato direttamente, se si desidera un feedback è necessario includere le informazioni di contatto da qualche parte.

Lascio il mio nome negli script SQL, poiché verranno principalmente recuperati direttamente dal database, non dal controllo del codice sorgente.