java - 我应该使用/* */或/** */作为Java文件顶部的版权吗？

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

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

要么

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

最佳答案

这个相当古老(大约在1999年)的Sun coding conventions文档建议使用/* */。

更具体地说，它为您的类/接口(interface)文件建议以下布局:

开始评论

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

package和import语句

类和接口(interface)声明(包括该类的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 {
    ...
}