18

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

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

或者

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

4 回答 4

11

这个相当古老（大约 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 {
    ...
}
于 2011-11-30T03:25:10.880 回答
10

Javadoc 只会收集/** ... */直接在任何要记录的声明之前的注释。 package（在 package-info.java 中除外）和import声明无论如何都没有记录，因此 Javadoc 不会以任何一种方式查看注释。

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

于 2011-11-30T09:51:49.637 回答
6

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

于 2011-11-30T02:54:18.673 回答
4

我刚刚阅读了一些开源java项目，发现它们都使用/* */

于 2011-11-30T02:58:44.843 回答