3 ms·
What I gather from this is that commit messages are a better place for documenting stuff like this than polluting every line of code with often redundant commen
by luord 7y ago
What I gather from this is that commit messages are a better place for documenting stuff like this than polluting every line of code with often redundant comments.
I like it.
- sethammons 7y agoI think the git log is an interesting place to document this kind of thing. Also, there should never be redundant comments. I do think though that lots of folks put things in the git log that _should_ be a code comment. For myself (as most of the people I can think of that I work with), we don't reference git commits unless we are actively investigating a previous change. You should not hide reasons for code being the way it is in the git commit; it should be exposed for direct observation to someone who might edit the code. Ex: '// the following delete call is required to remove the item from the DNS cache to ensure the test validates non cached dns items'. That should be in the code.