caicancai commented on PR #3872: URL: https://github.com/apache/calcite/pull/3872#issuecomment-2241349889
> @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 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
