Skip to content
New issue

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

Sign up for GitHub

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

Jump to bottom

Use SLASHSTAR instead of JAVADOC for Java #109

Merged
merged 1 commit into from
Feb 1, 2019
Merged

Use SLASHSTAR instead of JAVADOC for Java #109

merged 1 commit into from
Feb 1, 2019

Commits on Aug 12, 2016

  1. Use SLASHSTAR instead of JAVADOC for Java 

    In Java JAVADOC-style comment blocks are intended for comments
interpreted by documentation building tools such as `javadoc`. Strictly
speaking, the license header block should not be interpreted by these
tools. The common approach in Java is to use the uninterpreted
SLASHSTAR-style of comments for the license header.

Recent iterations of the JDK have been getting stricter with its
parsing of Javadoc comment blocks; floating comment block not applied to
any Java element (type, method, or field) may well result in warnings in
future versions of the compiler. In JetBrain's IntelliJ Java IDE,
Javadoc-style license headers already cause a syntax warning.

While the style of comments can be configured (as mentioned in mathieucarbou#43
'License headers shouldn't be in Javadoc style') a sensible default
seems preferable.
    @jdhoek
    jdhoek committed Aug 12, 2016
    Configuration menu
    Copy the full SHA
    b3e4193 View commit details
    Browse the repository at this point in the history