Skip to content

Fixed comments - Changed single comments to multiline #6077

New issue

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

By clicking “No 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? No Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

muskan10
Copy link

@muskan10 muskan10 commented Apr 30, 2025

Motivation and Context

Multi line comments were configured as single line comments.

Modifications

Testing

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document
  • Local run of mvn install succeeds
  • My code follows the code style of this project
  • My change requires a change to the Javadoc documentation
  • I have updated the Javadoc documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
  • My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

  • I confirm that this pull request can be released under the Apache 2 license

@muskan10 muskan10 requested a review from a team as a code owner April 30, 2025 12:49
@debora-ito
Copy link
Member

Hi @muskan10 thank you for the contribution.

The change to multi line comments does not provide any improvements though, the end result is the same. Can you share about the motivation behind it?

@muskan10
Copy link
Author

Hi @muskan10 thank you for the contribution.

The change to multi line comments does not provide any improvements though, the end result is the same. Can you share about the motivation behind it?

Hi @debora-ito ,
Thanks for the review,

The motivation behind switching to a multi-line comment format was to align with Java-style documentation practices, where multi-line comments (/** ... */) are typically used to describe complex or logic-heavy sections of code.

The existing comments were more in the style of end-of-line or inline comments, which—per the official Java code conventions—are better suited for short explanations or brief clarifications.

To follow these best practices and improve readability for future maintainers, I reformatted the comment block accordingly.

No Sign up for free to join this conversation on GitHub. Already have an account? No Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants