A volte metto un link al sito dove ho copiato un pezzo di codice nel caso in cui dimentichi cosa fa. È una cattiva pratica? Dovrei copiare la spiegazione dal sito invece di collegarla ad essa?
A volte metto un link al sito dove ho copiato un pezzo di codice nel caso in cui dimentichi cosa fa. È una cattiva pratica? Dovrei copiare la spiegazione dal sito invece di collegarla ad essa?
Penso che dipenda. se è ovvio quale sia il codice non è probabilmente necessario un collegamento. Mi piace aggiungere un collegamento a un articolo con una breve descrizione del contenuto, se non è ovvio che cosa sta succedendo o se si devia dal normale modo di fare qualcosa o si ha un caso limite speciale. Non dimenticare che le pagine internet non restano per sempre, ecco perché non lascio mai solo un link.
Inoltre dovresti considerare se il caso garantisce che espandi la documentazione del tuo progetto.
Is this a bad practice?
Sì.
Should I copy the explanation from the site instead of linking to it?
No.
La risposta corretta è di documentare il pezzo di codice con parole tue. Ciò significa, invece di limitarsi a copiare, comprenderlo per documentarlo.
Leggi altre domande sui tag comments