5 ms·
If you have to mention requirements in your comments, don’t mention peoples names. Jim from sales probably moved on from the company and most likely the program
by dkarl 16y ago
If you have to mention requirements in your comments, don’t mention peoples names. Jim from sales probably moved on from the company and most likely the programmers reading this won’t know who he is. Not to mention the fact that it everything else in the comment is irrelevant.
If this is the best knowledge you have of the requirements, then by all means document it. It should be documented in emails to your boss (along with your failed attempts at getting better requirements,) but adding a comment in the code can also be helpful. Maintenance programmers tend to assume that there's some valid, if depressing, reason the code is the way it is, and it's nice to let them know that you didn't have any good reason for doing it the way you did.