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.

Sign up for GitHub

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

Update code style for ordering things inside classes #6125

Merged
merged 5 commits into from
Oct 11, 2024
Merged

Update code style for ordering things inside classes #6125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b817db6
Update code style for ordering things inside classes
optionsome Oct 8, 2024
f2075c7
Apply suggestions from code review
optionsome Oct 10, 2024
ec01a7d
Update doc/dev/decisionrecords/Codestyle.md
optionsome Oct 10, 2024
8704e9b
Remove separate visibility rules
optionsome Oct 10, 2024
05a6f6d
Put javadoc instructions in one place
optionsome Oct 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 20 additions & 21 deletions doc/dev/decisionrecords/Codestyle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,30 +115,29 @@ The provided formatter will group class members in this order:
2. Overridden methods are kept together
3. Dependent methods are sorted in a breadth-first order.
4. Members are sorted like this:
1. `static` `final` fields
2. `static` fields
3. `static` initializer
4. `final` fields
5. fields
6. class initializer (avoid using it)
7. Constructor
8. `static` methods
9. `static` getter and setters
10. methods
11. getter and setters
12. enums
13. interfaces
14. `static` classes
15. classes
5. Each section of members are sorted by visibility:
1. ´public´
2. package private
3. ´protected´
4. ´private´
1. `static` `final` fields (constants)
2. `static` fields (avoid)
3. instance fields
4. static initializer
5. class initializer
6. constructor
7. `static` factory methods
8. `public` methods
9. getter and setters
8. `private`/package methods
10. `private` enums (avoid `public`)
11. interfaces
12. `private static` classes (avoid `public`)
13. instance classes (avoid)

### JavaDoc Guidlines

What to put in Javadoc:
As a matter of [policy](http://github.com/opentripplanner/OpenTripPlanner/issues/93), all new
methods, classes, and fields should include comments explaining what they are for and any other
pertinent information. For Java code, the comments should follow industry standards. It is best to
provide comments that not only explain *what* you did but also *why you did it* while providing some
context. Please avoid including trivial Javadoc or the empty Javadoc stubs added by IDEs, such as
`@param` annotations with no description.

- On methods:
- Side effects on instance state (is it a pure function)
Expand Down
10 changes: 0 additions & 10 deletions doc/user/Developers-Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,16 +106,6 @@ standards:
2. Strip out any unneeded information by using the `osmium filter-tags` as describe
in [Preparing OSM](Preparing-OSM.md)

### Code Comments

As a matter of [policy](http://github.com/opentripplanner/OpenTripPlanner/issues/93), all new
methods, classes, and fields should include comments explaining what they are for and any other
pertinent information. For Java code, the comments should use the
[JavaDoc conventions](http://java.sun.com/j2se/javadoc/writingdoccomments). It is best to provide
comments that not only explain *what* you did but also *why you did it* while providing some
context. Please avoid including trivial Javadoc or the empty Javadoc stubs added by IDEs, such as
`@param` annotations with no description.

### Itinerary and API Snapshot Tests

To test the itinerary generation, and the API there are snapshot test which save the result of the
Expand Down
Loading