Programın yorumlarında Soru ve Cevap sitelerine bağlantı koymak uygun mudur?

Oldukça bazı kod tabanlarında aşağıdaki gibi şeyleri belirten yorumları görebilirsiniz:

 // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade)

Birkaç sorum var, ama hepsi birbiriyle ilişkili.

Bir programın yorumlarında SO sorularına bağlantı koymak doğru mu?

 // We're now mapping from the "sorted-on column" to original indices.
 //
 // There's apparently no easy way to do this in Java, so we're
 // re-inventing a wheel.
 //
 // (see why here, in SO question: http://stackoverflow.com/questions/951848)

Yapar mısın?

Ve bunu yapmanın dezavantajları nelerdir? (korkunç bir dezavantaj için ilk yorumuma bakın)

Bunu, özellikle Stack Overflow için değil, teknik bloglar, forumlar, Usenet, Google Grupları veya "bunu neden yaptım" bağlamından tamamen açık olmayabilir.

Eski soruları arşivlemeden ve temizlemedikçe SO'yu neden böyle kullanmanın kötü bir şey olduğunu anlamıyorum (ki yaptıklarını sanmıyorum, ama emin değilim) - ama yapsalar bile, hayır herhangi bir siteden daha kötü.

Gerçekten endişeleniyorsanız, her zaman ekran görüntüsü alabilir veya bu sayfaları metin olarak indirebilirsiniz (veya resimleri, stil sayfalarını vb. Alma ve bunları şirketinizdeki bir bilgi havuzuna kaydetme, benzersiz tanımlayıcı ve daha sonra referans verebilmeniz için bu benzersiz tanımlayıcıyı yorumlarınıza koymak - bu tür şeyler için tutarlı bir yeriniz olur. Ancak, kodunuzun karmaşıklığına ve önemine bağlı olarak bu aşırıya kaçabilir.

Genellikle, bu bağlantıyı oluşturmanın en iyi yolu sürüm oluşturma sistemi ve / veya hata izleme sistemidir. Bunun çalışması için gereksinim kodunuzu hata izleyiciye veya yorumlarınızı koyduğunuz sürüm sistemindeki yere doğru bir şekilde bağlayabilmenizdir.

İdeal olarak, kodunuzun böyle yapılandırılmış olması gerekmez, çünkü iyi yapılandırılmıştır, vb. Ancak evet, durumunuz ideal olandan daha az olduğunda, böyle yorumlar koymak kabul edilebilir . Ve stackoverflow.com bağlantıları diğerlerinden daha iyi (ve genellikle daha iyi!).

Umarım geçici yorumlardırlar ve geri dönmenize ve kodu geliştirmenize ve bu yorumları çıkarmanıza izin verilir .

Koduma henüz bir StackOverflow.com bağlantısı koymadım. Kötü bir koku olduğu için kodları link koymaktan kaçınmaya çalışıyorum, ama zaman geldiğinde tereddüt etmeyeceğim.

Düzenleme : Yukarıdaki cevabım bunun gibi yorumlara duyulan ihtiyacın önlenebilir olduğu izlenimini verdiğini düşünüyorum. Tabii bazen öyle değil önlenebilir; kitaplığınızdaki veya kötü API tasarımınızdaki herhangi bir denetiminiz olmayan bir hatadır. Bağlantılar dahil olmak üzere bu gibi yorumlar, bir sonraki geliştiricinin gelmesi için çok yararlıdır.

Bunu bir araştırma makalesi yazmak gibi görüyorum. Başkasının fikirlerini kullanırsam, o fikirlere kredi vermem gerekir. Daha önce kodumda stackoverflow bir yanıt kullandım ve yöntem yorumlarına bağlantı ekledi.

Birinin de belirttiği gibi, SO bir wiki tarzıdır, bu yüzden değişebilir, ancak genellikle fikir hala aynı olmalıdır.

Fikirlerini kullanırken hala başkalarına kredi vermelisiniz.

Bir geçici çözüm uygulamaya ihtiyaç duyduysanız ve uygulamanın neden belirli bir şekilde yapıldığı açık değilse , bunun nedenlerini tanımlamak için gerçekten bir yorum yapılmasına izin verilmelidir. Çevrimiçi referansa bir bağlantı yerleştirmenin iyi olduğunu düşünüyorum, ancak yorumunuzu kısa ve öz, ancak okuyucunuzun akıl yürütmenizi iki kez kontrol etme ihtiyacı duyması durumunda bağlantının yalnızca genişletilmiş bir açıklama sağlayacağı kadar tamamlamanız gerekir.

Öte yandan, kod aynen kopyalanmışsa, orijinal kaynağa bir bağlantı sadece adildir ve orijinal yazarın çalışmasını kopyalamanıza izin verilen lisansın ifadesine bağlı olarak gerekebilir.