-
Notifications
You must be signed in to change notification settings - Fork 0
Comments and Documentation
OneLemonyBoi edited this page Apr 3, 2023
·
3 revisions
Ideally, comments should only be used when required. Quickly readable code is key, and simple functions should not need comments. When writing comments, make sure to focus on key details.
All classes and functions need JavaDocs written for them. Even if they're simple, they will be used to create quickly readable documentation for new and old members alike and are extremely helpful. Make sure to go into detail in these JavaDocs, and list each parameter and its description/function.