|
|
|
|
|
|
by JohnFen
2296 days ago
|
|
|
> I am forever grateful to past engineers for outlining WHY they made their changes, and not WHAT the changes were per se. Oh, so much this! The same applies to in-code comments. If your revision notes (or your code comments) are only telling me what I can plainly read in the code, then they're utterly pointless. Tell me what I can't read in the code: the "why"s, as well as potential consequences and "gotchas" the changes may present. |
|
|