You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'll be documenting this on the DevelopersGuide, but for posterity I wanted to make a ticket for this. On the 12/11 call, we all agreed that all new classes, methods, and fields should have JavaDoc comments explaining what they are. For fields with getters and setters, the documentation should go above the getter.
Much of the existing code is lacking such commenting. Moving forward, we should make an effort to document existing code, and ''all'' new code must be documented.
The text was updated successfully, but these errors were encountered:
I'll be documenting this on the DevelopersGuide, but for posterity I wanted to make a ticket for this. On the 12/11 call, we all agreed that all new classes, methods, and fields should have JavaDoc comments explaining what they are. For fields with getters and setters, the documentation should go above the getter.
Much of the existing code is lacking such commenting. Moving forward, we should make an effort to document existing code, and ''all'' new code must be documented.
The text was updated successfully, but these errors were encountered: