我应该使用/ * * /还是/ ** * /作为java文件顶部的版权？

Question

每个java文件都有版权注释，但我不知道应该使用哪一个：/* */或/** */？

/* 
    * Copyright ... 
    */ 
import java.util.* 
... 

或

/** 
* Copyright ... 
*/ 
import java.util.* 
.... 

Answer 1

这相当老（大约1999年）太阳coding conventions文件建议/* */。

更具体地说，它表明了以下布局为你的类/接口文件（S）：

• 开始评论

  /* 
  * Classname 
  * Version information 
  * Date 
  * Copyright notice 
  */ 
  

• package和import声明
• 类和接口声明（其中包括Javadoc对该课程的评论 - 参见表格条目＃1）。

例子：

/* 
* MyClass 
* 
* v1.0 
* 
* 2011-11-29 
* 
* This file is copyrighted in an awesome way. 
*/ 
package com.example.mypackage; 

import com.example.otherpackage; 

/** 
* Javadoc comments for the class. 
*/ 
public class MyClass { 
    ... 
} 

Answer 2

如果使用/** */文档化工具将抓住它，所以你最好不要使用它:)

Answer 3

我只是看了一些开源Java项目，发现他们都使用/* */

Answer 4

Javadoc将只收集/** ... */意见，如果他们是直接被记录任何声明之前。 package（除package-info.java外）和import声明无论如何都没有记录，因此Javadoc不会以任何方式查看注释。

由于对Javadoc无关紧要，您可以使用“不太重”的/* ... */版本。