drill-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From paul-rogers <...@git.apache.org>
Subject [GitHub] drill pull request #784: DRILL-5355: Misc. code cleanup
Date Wed, 15 Mar 2017 02:05:07 GMT
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.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message