4 ms·
Both of your examples require the developer to access some resource outside of the code itself in order to understand what the code is doing (or why it is doing
by thaumaturgy 8y ago
Both of your examples require the developer to access some resource outside of the code itself in order to understand what the code is doing (or why it is doing it).
So those things are both good also, but I consider them to be a fallback for cases where the code isn't commented like it should be.
- chrisweekly 8y agoComments can provide context by simply providing a link like "See Issue/ticket/card ID #123". That plus git blame, good commit messages, and feature branches named for the same ID, makes for a coherent whole -- without adding much overhead in terms of comment writing and maintenance.