Quixoticgeek on Nostr: There's a lot of discussion among coders about comments, some say that good code ...
There's a lot of discussion among coders about comments, some say that good code shouldn't need commenting.
But the thing a lot of people fail to understand with comments is that you don't just want to say what th code is doing. But why. The why is often more important. I have a code base I've taken over maintenance of, and in the execution there's a 60 second delay in there. But there's no details of why. What breaks if I remove it? Do I want to find out the hardway?
Published at
2024-05-17 13:17:20Event JSON
{
"id": "cf145aa3aba702ecac391b18b1493398eae92063b81ffea9452e1ca8d5322b91",
"pubkey": "152fb8cb6e662dc8ed2acb9e8590187ac1b047635daa124139ba77c26066f16e",
"created_at": 1715951840,
"kind": 1,
"tags": [
[
"proxy",
"https://social.v.st/users/quixoticgeek/statuses/112456619841845611",
"activitypub"
]
],
"content": "There's a lot of discussion among coders about comments, some say that good code shouldn't need commenting.\n\nBut the thing a lot of people fail to understand with comments is that you don't just want to say what th code is doing. But why. The why is often more important. I have a code base I've taken over maintenance of, and in the execution there's a 60 second delay in there. But there's no details of why. What breaks if I remove it? Do I want to find out the hardway?",
"sig": "c7fe708ec84fb9203911bd6e7d141825b3e41cc5927ffbc7905937078543c68ac4d242217f9226f45f0df6f388bcdfc4d958b0f1c0b0eee687fd7fdab7ae1cd6"
}