Firmate ciascuno dei vostri file sorgente con il vostro nome? [duplicare]

Non proprio, no. Ci sono un paio di motivi per cui:

• Il tuo sistema di controllo della versione (VCS) memorizza già questi metadati . Per esempio. ogni commit in git ha un campo per il nome che ha effettuato il commit. I sistemi di controllo delle versioni competenti consentono di vedere chi ha apportato una modifica a una specifica riga di codice. Quella funzionalità è solitamente chiamata blame che è un termine improprio poiché, invece di trovare qualcuno che faccia effettivamente incolpare , è molto utile per trovare qualcuno con cui parlare di un problema che si ha nel contesto di il pezzo di codice).

  Ho visto alcuni commenti di intestazione che hanno anche il log della cronologia, ma che possono essere facilmente estratti da un VCS.

• Scoraggia la collaborazione del codice . "Ehi, qualcuno l'ha fatto ... forse non dovremmo toccare il suo codice". Se non esiste una proprietà esclusiva del codice su alcuni file del codice sorgente, allora la possibilità più alta che qualcun altro lo cambierà, il che a sua volta facilita e abilita il refactoring.

Per quanto riguarda le informazioni sul copyright?

Anche se per motivi di copyright potresti voler aggiungere il nome della società come detentore del copyright nei commenti di intestazione (ovvero banner di copyright). Se si tratta di un progetto open source, spesso è il nome dell'organizzazione del manutentore o un solo manutentore. Tuttavia è ormai prassi comune inserire queste informazioni in file di testo nella radice del progetto. Puoi vedere questi file di testo fatti su progetti open source con nomi come README , LICENSE e / o CONTRIBUTORS .

Che dire degli script di database?

Si potrebbe argomentare che è necessario fare registri di cronologia nei commenti di intestazione con gli script SQL del database sebbene ultimamente con gli strumenti di migrazione del database abbia reso questa pratica obsoleta. Gli strumenti di migrazione del database di solito tengono traccia di quali migrazioni sono state eseguite e possono eseguire rollback secondo necessità. Questi strumenti sono più flessibili da utilizzare rispetto a un file di testo.

Non lo faccio, in particolare come hai detto perché è tracciato nel controllo del codice sorgente. Ogni volta che informazioni come questa vengono conservate in due parti (controllo del codice sorgente e il file stesso come hai detto tu), diventeranno fuori sincrono . Dal momento che il controllo del codice sorgente aggiunge automaticamente le informazioni, non penso ci sia alcun motivo per includerlo direttamente.

Detto questo, se c'è qualcosa di non ovvio che stai aggiungendo, o potrebbe giustificare ulteriori discussioni, penso che valga la pena aggiungere commenti attorno a un blocco di codice che indica la modifica apportata e perché con il tuo nome.

Sì, firmo il mio codice. Sono orgoglioso di produrre un lavoro di qualità.

Should I also be signing files I work on for any other reasons? Do you? If so, why?

C'è un motivo per mettere il tuo nome nei tuoi file. Il libro "The Pragmatic Programmer" lo incoraggia, perché gli autori presumono che scriverai un codice migliore quando il tuo nome è scritto su di esso, così puoi essere orgoglioso del tuo lavoro. I programmatori non vorrebbero firmare pezzi di codice disordinati, vero?

Bene, ecco dove colpisce la realtà. La maggior parte delle volte , solo l'autore iniziale è nei file e, come altri qui indicati, queste informazioni saranno fuori sincrono a breve. E non impedisce il codice disordinato. La maggior parte semplicemente ignora il fatto che il loro nome è elencato nell'intestazione del file. Questo non è affatto un consiglio pragmatico, da un libro altrimenti eccellente, anche se per alcune persone può fare la differenza.

Un altro motivo per mantenere il tuo nome nei file è quando vuoi pubblicare il codice sorgente, ad esempio per un progetto open source. Questo può essere visto come una sorta di pubblicità.

Ma nei casi più , questa informazione è solo un rumore ridondante.

git blame (o svn blame se devi) è uno strumento molto migliore per dedurre la "proprietà" del codice rispetto a una linea singola nella parte superiore di un file, specialmente dopo che un progetto è cresciuto di alcuni baffi.

No, non lo so. Tuttavia, qualsiasi intestazione obbligatoria (un particolare commento di intestazione standard aziendale fa parte delle linee guida dello stile di codifica) è incluso, quindi se lo richiedono come parte di essi, allora lo farei. Se non hai stili di programmazione, di programma o di codifica aziendale, dovresti, e ogni commento di intestazione del file obbligatorio dovrebbe essere chiaramente definito.

Come hai detto, il controllo della versione dovrebbe gestirlo. Quando altre persone toccano il file, devono aggiornare un campo già tracciato automaticamente dal controllo di versione, che identifica esattamente ciò che è stato cambiato e chi ha apportato la modifica tra ogni versione? Sembra un sovraccarico, soprattutto se uno sviluppatore si dimentica di aggiornarlo e gli sviluppatori futuri passano per l'intestazione anziché cercare nel controllo di versione.

Sì. Il motivo non è perché voglio "possederlo" in qualche modo, mettendo il mio nome su di esso. Se qualcuno volesse modificare quella linea, me ne potrebbe importare di meno. E dire che il controllo della versione memorizzerà i miei dati è vero, e tuttavia inutile se qualcuno non ha accesso al mio repo.

Lavoro per una grande azienda e il mio codice vaga dalla business unit alla business unit. Il povero schmuck che ottiene il codice da un ragazzo, che l'ha preso da un altro ragazzo, che l'ha preso dal mio capo idiota, non avrà la più pallida idea di chi chiamare per il supporto a meno che non lasci un suggerimento nel codice stesso.

E, poiché non mi aspetto di rimanere qui per sempre, lascio le reali informazioni di contatto, così le persone possono contattarmi dopo che ho lasciato il mio attuale lavoro se hanno bisogno di qualcosa. È solo cortesia.

Perché vorresti un commento con il nome di qualcuno inserito nel codice sorgente?

Se non offre informazioni sull'intento del codice e a meno che non ti sforzi di ricordare il tuo nome non ha alcun valore che io possa vedere.

Sarebbe rimosso al prossimo commit se lo avessi trovato.

Ovviamente, i commenti sono generalmente un odore in sé, ma questo è un altro argomento:)

Il mio IDE inserisce automaticamente i nomi utente nella parte superiore dei file quando crei una nuova classe. In realtà è piuttosto noioso, perché ignoriamo l'intestazione.

hm, forse dovremmo istituire un nuovo standard di codifica in cui tutti devono disattivarlo nelle preferenze del proprio IDE e / o eliminare l'intestazione automatica ...

Nella mia azienda, utilizziamo un'intestazione standardizzata con una nota di copyright per il nome della nostra società e campi chiave per il controllo della versione, come Revisione, Data, Id

Per noi è normale inserire il nostro nome nel codice sorgente e inoltre, se lo modifichiamo, contrassegnare tali modifiche con un numero di modifica e il nostro nome rispetto al numero di modifica.

TBH, questo è il tipo di cosa che mi sarei aspettato di vedere negli standard di codifica interna.

Penso che non sia una cattiva abitudine.

Altri sostengono che VCS lo farà per te. Bene, fino a un certo punto, è vero.

Se tuttavia rilasci codice sotto un copyleft debole (MIT o qualsiasi altra cosa), puoi quasi scommettere che qualcuno integrerà un'istantanea del tuo codice nella loro base di codice e apporterà le proprie modifiche. Non saranno in grado di distinguere tra i commenti originali e i commenti della persona che ha effettuato il check-in originale.

La stessa cosa si applica quando le basi di codice si spostano su altri VCS (ad esempio da CVS a git). Non puoi davvero sapere se tutti i metadati lo faranno nel nuovo VCS (mi aspetterei che ci sia un modo per migrarlo).

Quindi per rispondere alla domanda:

Quando aggiunge un valore significativo per conoscere l'autore di un pezzo di codice (che non è sempre il caso), piuttosto che aggiungere l'autore direttamente nel file sorgente è una buona idea. Ciò non significa che devi documentare e firmare ogni singola modifica apportata a un file sorgente.

L'unica ragione per mettere il tuo nome in cima a un file è quando si tratta di un compito a casa e il tuo professore lo richiede per tenere a mente quale studente ha scritto il codice che sta guardando su una stampa.