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

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

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

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

答案 1

这个相当古老的(大约1999年)Sun编码约定文档建议。/* */

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

  • 开始注释

    /*
     * 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 {
    ...
}

答案 2

Javadoc 只会收集注释,如果它们直接位于要记录的任何声明之前。 (除了在package-info中.java)和声明无论如何都没有记录,所以Javadoc不会以任何一种方式查看注释。/** ... */packageimport

由于这对Javadoc来说无关紧要,因此您也可以使用“不那么重”的版本。/* ... */