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

Question

每个java文件都有版权评论,但我不知道应该使用哪一个:/* */或者/** */？

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

要么

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

Answer 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 {
    ...
}

Answer 2

Javadoc只会/** ... */在任何要记录的声明之前收集评论. package(除了在package-info.java中)并且import声明都没有记录,所以Javadoc不会以任何方式查看注释.

因为它对Javadoc无关紧要,你也可以使用"不太沉重"的/* ... */版本.

Answer 3

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