Di solito c'è un tag @author nella documentazione API (JavaDoc, PHPDoc, ecc.). È accettabile usare questo tag su ogni funzione che fai in un prodotto commerciale?
Il tag dell'autore può avere due scopi:
Scopo 1 può essere un uso legittimo per progetti alcuni , ma il suo utilizzo deve essere governato e applicato dal team di progetto. Per il progetto commerciale closed-source, è probabile che questo utilizzo possa essere proibito .
Lo scopo 2 può servire a una legittima, ma transitoria (temporanea) necessità di contribuire a stabilire più punti di contatto in team distribuiti che normalmente non comunicano . In altre parole, team che avevano canali di comunicazione rotti o inesistenti e mancavano alcune pratiche di sviluppo software standard. Mettendo queste informazioni in un wiki del progetto, o assicurando che la cronologia del commit del controllo del codice sorgente sia accurata e accessibile a tutti (sviluppatori e utenti API), sarà un'alternativa migliore.
Consulta il lead del progetto se incontri questo tag nel codice esistente , per vedere se deve essere conservato o rimosso.
Se vedi questo tag che fa riferimento a una persona non nella tua azienda , potrebbe essere un segno di appropriazione indebita del codice (ad esempio rubare codice da altre fonti senza attribuzione e / o licenza), che è un problema diverso e molto più grande.
Heh, non avrei mai pensato che usando il tag @author stavo rivendicando la proprietà del codice, nella mia mente era più un commento "se questo rompe, incolpa me". Per molto tempo ho rinunciato a scrivere tali commenti, il controllo della versione è il mio modo preferito per trovare a chi dare la colpa quando si rompono .
Se è necessario mostrare la proprietà del codice in senso legale, inserire il tag @author nel documento DocBlock di livello pagina / classe e non dimenticare di puntare alla licenza del codice con il tag @license .
Leggi altre domande sui tag documentation tagging