[
https://issues.apache.org/jira/browse/DRILL-5355?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15925418#comment-15925418
]
ASF GitHub Bot commented on DRILL-5355:
---------------------------------------
Github user paul-rogers commented on a diff in the pull request:
https://github.com/apache/drill/pull/784#discussion_r106071847
--- Diff:
logical/src/main/java/org/apache/drill/common/expression/FieldReference.java ---
@@ -1,4 +1,4 @@
-/**
--- End diff --
In Java, comments of the form /** ... */ are Javadoc comments; they are
copied into the Javadoc generated for the code. If we put the copyright in such
comments, it will appear at the top of the Javadoc file for the class.
Most projects do no include a copyright notice at the top of each Javadoc
file (at least not in the visible HTML shown to readers.) Our copyright notice
is not formatted for Javadoc, so it is unlikely that our goal is to include the
notice in Javadoc.
By contrast, the /* ... */ style comment is a simple code comment, not
copied into Javadoc. So, to avoid showing the copyright in Javadoc, we use the
plain-comment style instead.
> Misc. code cleanup
> -------------------
>
> Key: DRILL-5355
> URL: https://issues.apache.org/jira/browse/DRILL-5355
> Project: Apache Drill
> Issue Type: Improvement
> Affects Versions: 1.10.0
> Reporter: Paul Rogers
> Assignee: Paul Rogers
> Priority: Minor
> Fix For: 1.11.0
>
>
> Recent work in Drill has identified a number of cases where code can be
> cleaned up: adding missing annotations, etc. These changes don't fit as part
> of a separate ticket and so are rolled up into a this "general hygiene"
> ticket.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
