-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Formatting
A lot of the code is decently-formatted. I've created a style guide. It mostly is simaler to what we already have, but also is explicitly spelled-out.
Tidyness + Documentation
For docs, I'm working on setting up JavaDoc for documentation, and plan to slowly add JavaDoc comments.
- Setup build script (see issue Add script to build docs, update readme with directions for building docs #25)
- Document the code
- Remove all the
@authorJavaDoc comments (active PR, see Remove @author JavaDoc, remove automatically generated file headers #27) - Add file headers as needed
Additionally, as I format it, I plan to clean up the code a bit (remove things like@author gmein). Found that in over 10 places.
Commented out code
There is a decent amount of commented-out code. Most of it was clearly used for debugging (e.g., // System.out.println(...);).
I'm torn on what to do with it. Part of me thinks it could be helpful for the next person that debugs the code. The other part of me says it is irrelevant to the code and should be removed, as it will rot. After all, Git will always have a copy of it.
One example of commented-out code is here. Here are the options I see:
- Leave the commented-out code - Ugly, and potentially annoying (if the code arround the commented-out code changes, the commented-out code will quickly rot)
- Delete the commented-out code - Someone debugging would have to re-add the comments, but it would be saved in Git. Moreover, and this is my opionion: code that is purely for debugging, and that is commented-out (rendering it useless, especially if the surrounding code changes) does not belong. Perhaps it is fine to have while debugging, or maybe in a development branch, but not the primary branch. Moreover, sooner or later, the commented-out code will rot.
- Hide it behind a boolean. E.g.,
if(DEBUGGING_MODE = true) {. Personally, I feel that is lots of work and effort that would be better put to other tasks.
Thoughts?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request