Spesso durante la codifica mi trovo bloccato su un problema particolarmente difficile e cercherò una soluzione. Il più delle volte questo mi porta a una domanda StackOverflow che fornisce una soluzione completa o parziale, spesso con codice che può essere utilizzato direttamente incollando nel codice originale.
In alcuni casi questo può portare a un codice apparentemente non intuitivo o a cose apparentemente insolite - come sovraccaricare metodi esistenti nelle classi, reimplementare funzioni integrate con lo stesso nome o altrimenti rompere alcuni aspetti di "buone pratiche" per raggiungere una soluzione. A volte queste sembrano pratiche sbagliate, ma a causa di problemi nel codice
In casi come questi mi capita spesso di includere un link alla risposta che ho implementato, con qualche breve spiegazione piuttosto che riscrivere o duplicare spiegazioni dettagliate.
Includere gli URL alle soluzioni per questi tipi di problemi nei commenti è una pratica comune, oppure esiste un modo migliore per documentare questo tipo di codice?
Come esempio di questo tipo di problema, Di recente ho fatto una domanda sulla risoluzione di un conflitto con il decoratore di proprietà Python , dove la soluzione era quella di rinominare la funzione in-built di Python e incluso un link alla domanda nel codice .