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 15:17:20Event JSON
{
"id": "709938829cdfabe45bbe09b958a2780c064c961fdf9c07f9cf7a29889dd3f3e7",
"pubkey": "ca32e4cc80318379bffc39297bf3262774fa2786e4fd34467b80ff805138d27c",
"created_at": 1715951840,
"kind": 1,
"tags": [
[
"proxy",
"https://social.v.st/@quixoticgeek/112456619841845611",
"web"
],
[
"proxy",
"https://social.v.st/users/quixoticgeek/statuses/112456619841845611",
"activitypub"
],
[
"L",
"pink.momostr"
],
[
"l",
"pink.momostr.activitypub:https://social.v.st/users/quixoticgeek/statuses/112456619841845611",
"pink.momostr"
]
],
"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": "b9ad3b5cfc8bf18181fd9373f47da2f35b1e9d5ff258c17373a2152dcadf22ab1100b654be9050f628de03a5a09cd1e2a92b86ce0708c4fc73740abba73873e2"
}