Öncelikle, bu soruda kaynak kod yorumlamanın iyi ya da kötü olup olmadığı konusunda polemikten uzak durmak istiyorum. Sadece insanların NEDEN, NE veya NASIL olduğunu söyleyen yorumlar hakkında konuştuklarında ne anlama geldiklerini daha net anlamaya çalışıyorum.
Sık sık "Yorumlar size NEDEN söylemelidir; kodun NASIL olduğunu söylemelidir" gibi yönergeler görüyoruz. Soyut bir seviyedeki ifadeyle aynı fikirde olmak kolaydır. Ancak, insanlar bunu genellikle bir dogma gibi bırakırlar ve daha fazla açıklama yapmadan odadan çıkarlar. Bunu birçok farklı yerde ve bağlamda kullandım, insanlar parantez üzerinde hemfikir olabilir gibi görünüyorlar, ama tamamen farklı şeyler hakkında konuşuyor gibi görünüyorlar.
Öyleyse, soruya geri dönelim: Yorumlar size NEDEN anlatmalıysa, neden NEDEN bahsettik? Bu ilk etapta bu kod parçasının bulunmasının nedeni bu mu? Bu parça kodunun yapması gereken bu mu? Birisinin net bir açıklama yapıp yapamayacağına gerçekten çok sevinirim ve sonra bazı iyi örnekler eklerim (kötü örneklere gerçekten ihtiyaç duyulmaz, ancak bunları kontrast eklemek için serbest bırakılır).
Yorumların iyi ya da kötü olup olmadığına dair birçok soru var, ancak size Niçin olduğunu söyleyen iyi yorum örnekleri hakkında kesin soruya değinen kimse yok
There are many questions on whether comments are good or bad, but no one that addresses the specific question of what are good examples of comments that tell you WHY.
Herkes geçerli bir örnek verirse, hepsi doğru cevaplardır. Bu web sitesinin formatı, tüm cevapların eşit yaratılmadığı bir soru-cevap sürecini kolaylaştırmak içindir.