È una cattiva pratica citare URL come riferimenti nei commenti? [chiuso]

Puoi inserire URL nei tuoi commenti, ma considera i problemi che potrebbe sollevare:

• Nessuno copia effettivamente il link e va a leggere ciò che effettivamente dice il contenuto dell'URL.
• Il link / sito potrebbe non essere lì un anno in futuro, o anche la prossima settimana
• Potresti dimenticare di aggiornare il commento quando il codice sottostante cambia, il che confonderà ulteriormente un futuro lettore.

Credo che non dovresti inserire URL nei tuoi commenti a meno che tu incolpi anche la citazione pertinente , e quindi l'URL sia usato solo come re-enforcement per il commento, o come approfondimento ulteriore.

Finché tu e il tuo team sarete disciplinati sui commenti, certo.

Utilizza siti affidabili a lungo termine per i tuoi riferimenti:

a) wiki o altri siti interni gestiti dal tuo team per la vita del progetto.

b) siti interni gestiti dalla tua organizzazione che hanno un contratto di manutenzione a lungo termine per quanto riguarda la conservazione dei collegamenti.

c) siti esterni che hanno impegni per il mantenimento a lungo termine dei collegamenti. Ad esempio, wikipedia, scambio di stack, siti di fornitori open source, ecc.

Le alternative per inserire link nei tuoi commenti sono spesso peggiori.

1) Manutenzione multipla: non ripetersi in una spiegazione di un'istanza di codifica, specialmente quando interessa più parti del codice sorgente.

2) Il tentativo di riepilogare una discussione a bordo quando hai già implementato il codice è spesso ridondante.