Re:On Comments in Code
by Nullabillity on Tuesday June 15, 2021 @06:42PM
(#27522540)
Sounds like a good use case for property testing!
Is there a reason you don't leave a comment with the commit hash of the change instead?
Some day in the distant future someone will only have a tarball of the source of the last version that worked; if they're lucky.
Save that poor sod; have your comments live in your code, not in an SCM system for your code.
GPL has this idea in it: trying to define what exactly should go into that tarball. The question seems meaningful and important even for proprietary code. If some authors assume that anybody modifying their code should be able to look at git commits, that probably simply means that "the preferred form of the work for making modifications to it" is a git repo.
If I come up with an inefficient algorithm that's short and readable, I tend to optimise it to something better but leave the reference implementation inside a code block.
(This goes without saying, but: I don't leave "commented code", but code inside comment, generally formatted with Markdown)