Question

建议在每个文件的顶部添加一个许可标题，其中包括版权和许可信息（例如，GPL3建议添加this）。是否有标准的注释样式用于Java中的许可证标题，或者我可以使用我喜欢的任何内容吗？

我知道License Maven Plugin建议使用Javadoc样式的评论，这就是我现在正在使用的，但最近发现some projects使用简单的多行表彰（只有一个*相反。使用Javadoc工具时，类似Javadoc的注释会产生问题吗？

Answer 1

你应该使用/* */，它似乎是大多数开源java项目的标准。应该使用Javadoc来描述Java类，接口，构造函数，方法和字段。

但是，如果你想使用Javadoc，我想你可以，如果你在它之后添加一个import语句，它将无法继续使用。根据{{3}}的意见放置：

常见的错误是在类注释和类声明之间放置一个import语句。避免这种情况，因为Javadoc工具将忽略类注释。

/**
* This is the class comment for the class Whatever.
*/

import com.sun;   // MISTAKE - Important not to put import statement here

public class Whatever {
}

Java中许可证头的注释样式

1 个答案: