Skip to content

Correct typos in Gradle file comments#3872

Merged
mihaibudiu merged 1 commit intoapache:mainfrom
caicancai:typo
Jul 22, 2024
Merged

Correct typos in Gradle file comments#3872
mihaibudiu merged 1 commit intoapache:mainfrom
caicancai:typo

Conversation

@caicancai
Copy link
Member

No description provided.

Copy link
Contributor

@mihaibudiu mihaibudiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically this is not javadoc

@caicancai caicancai changed the title Typo in JavaDoc Typo in Comment Jul 20, 2024
@caicancai caicancai changed the title Typo in Comment Correct typos in Gradle file comments Jul 20, 2024
@caicancai
Copy link
Member Author

caicancai commented Jul 20, 2024

Technically this is not javadoc

How about Correct typos in Gradle file comments?

@sonarqubecloud
Copy link

@mihaibudiu
Copy link
Contributor

Better

@NobiGo
Copy link
Contributor

NobiGo commented Jul 20, 2024

@caicancai @mihaibudiu Because there have been several instances where we have not reached a consensus on Java comments, in order to improve this situation, I do some research about java comment. How about we distinguish Java comments into two types, namely 'Java doc comments' and 'Java comments'(Don't include the Java doc comments).

  • Doc comments describe Java classes, interfaces, constructors, methods, and fields. Each doc comment is set inside the comment delimiters /**...*/, with one comment per class, interface, or member. This comment should appear just before the declaration.
  • Others include (block, single-line, trailing, and end-of-line). We collectively refer to it as Java comments.
  1. https://stackoverflow.com/questions/3607641/javadoc-comments-vs-block-comments
  2. https://www.oracle.com/java/technologies/javase/codeconventions-comments.html#385

@mihaibudiu
Copy link
Contributor

This was not a Java file

@caicancai
Copy link
Member Author

@caicancai @mihaibudiu Because there have been several instances where we have not reached a consensus on Java comments, in order to improve this situation, I do some research about java comment. How about we distinguish Java comments into two types, namely 'Java doc comments' and 'Java comments'(Don't include the Java doc comments).

  • Doc comments describe Java classes, interfaces, constructors, methods, and fields. Each doc comment is set inside the comment delimiters /**...*/, with one comment per class, interface, or member. This comment should appear just before the declaration.
  • Others include (block, single-line, trailing, and end-of-line). We collectively refer to it as Java comments.
  1. https://stackoverflow.com/questions/3607641/javadoc-comments-vs-block-comments
  2. https://www.oracle.com/java/technologies/javase/codeconventions-comments.html#385

Thank you, we can follow this later, but this PR is only to correct typos

@mihaibudiu mihaibudiu merged commit 14bde13 into apache:main Jul 22, 2024
@caicancai caicancai deleted the typo branch July 23, 2024 04:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants