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

Question

每个java文件里都有版权注释，但是不知道应该用哪个:/* */ or /** */？

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

或

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

Answer 1

这个相当古老(大约 1999 年)的太阳 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 {
    ...
}