Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

All new classes, methods, and fields should have JavaDoc comments #93

Closed
novalis opened this issue Jul 18, 2011 · 2 comments
Closed

All new classes, methods, and fields should have JavaDoc comments #93

novalis opened this issue Jul 18, 2011 · 2 comments

Comments

@novalis
Copy link
Contributor

novalis commented Jul 18, 2011

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.

@novalis
Copy link
Contributor Author

novalis commented Jul 18, 2011

Updated the DevelopersGuide.

--nicholasbs

@novalis
Copy link
Contributor Author

novalis commented Jul 18, 2011

{{{
#!html

}}}
This ticket has been referenced in ticket #78:

''Yes, we've closed ticket #93 (setting our commenting policy) and it's been documented in the DevelopersGuide...''

--nicholasbs

@novalis novalis closed this as completed Jul 18, 2011
kalon33 pushed a commit to kalon33/OpenTripPlanner that referenced this issue Sep 24, 2016
DT-1217 Add real time updates for P&R stations
flaktack pushed a commit to realCity/OpenTripPlanner that referenced this issue Jun 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant