Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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.
- Loading branch information