Much of the code base does not have as many comments as it might need or may have parts that are unclear. I will be working on this as it comes up and/or as I have time. If you are working on something someone else.
Prefer explaining what a method or class does in JavaDoc, without explaining how it does it. If explanation is required on how a task is accomplished, that should go in regular comments interspersed throughout the code.
Comment here any time you encounter a piece of code from our codebase that you don't understand and mention the author of that code in your comment, if possible.
Much of the code base does not have as many comments as it might need or may have parts that are unclear. I will be working on this as it comes up and/or as I have time. If you are working on something someone else.
Prefer explaining what a method or class does in JavaDoc, without explaining how it does it. If explanation is required on how a task is accomplished, that should go in regular comments interspersed throughout the code.
Comment here any time you encounter a piece of code from our codebase that you don't understand and mention the author of that code in your comment, if possible.