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

Comments

Projects
None yet
1 participant
@novalis
Collaborator

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

This comment has been minimized.

Collaborator

novalis commented Jul 18, 2011

Updated the DevelopersGuide.

--nicholasbs

@novalis

This comment has been minimized.

Collaborator

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 Jul 18, 2011

kalon33 pushed a commit to kalon33/OpenTripPlanner that referenced this issue Sep 24, 2016

Merge pull request opentripplanner#93 from HSLdevcom/hsl-p-and-r-updater
DT-1217 Add real time updates for P&R stations
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment