-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Refactor: BinaryImporter optimization + javadoc #2525
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
base: master
Are you sure you want to change the base?
Conversation
|
||
/** | ||
* Creates a new {@code BinaryImporter}. | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this Javadoc provide any non obvious information?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An empty default constructor clearly just creates a new instance. However, Javadoc for every constructor is a standard and necessary practice for the Java API. It ensures generated documentation is complete and maintains consistency throughout the project's style. Even if the content seems minimal, its presence is expected.
Raising questions on these well-established conventions slows down the review without adding significant value, and it takes away valuable time that could be dedicated to more complex and relevant code issues.
This PR improves the
BinaryImporter
class by modernizing its code and enhancing maintainability:These changes make the codebase easier to understand, safer, and more maintainable, while preserving existing functionality.