Question concerning comment length and verbosity
Hello everyone,
I'm currently an undergraduate student working on a programming project. The project itself is relatively non-trivial and as I've worked on it, I've found that I have tendency to write pretty long, multi-paragraph length comments around certain parts of my code.
These comments aren't really devoted to explaining how a part of the code does something. Rather, they focus on explaining what the code in question does, how different components of the program relate and inter-operate with other components of the program, and how these components fit into the overall design of the program.
My concern is that I'm simply putting to much info. into the comment, or that I'm talking too much about stuff that isn't pertinent to what the code does (e.g. describing how a certain component fits into the overall design of the program).
Is this the kind of information that should be reserved for like a README? Or is there some other more suitable place where this kind of information is typically placed? Or is it appropriate to put this info in my comments?
Thanks for taking the time to read my question!
Posted Mar 12, 2020, 6:15 AM UTC