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

发布于 2024-12-18 19:48:44 字数 239 浏览 5 评论 0原文

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

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

或者

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

原文

There is a copyright comment in each java file, but I don't know which one should I use: /* */ or /** */?

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

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

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

究竟谁懂我的在乎 2024-12-25 19:48:44

这个相当旧的（大约 1999 年）Sun 编码约定文件建议 /* */。

更具体地说，它建议您的类/接口文件采用以下布局：

开始注释
<前><代码>/*
* 类名
* 版本信息
* 日期
* 版权声明
*/
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 {
    ...
}

This rather old (circa 1999) Sun coding conventions document suggests /* */.

More specifically, it suggests the following layout for your class/interface file(s):

Beginning comments

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

package and import statements
Class and interface declarations (which includes Javadoc comments for the class - see table entry #1).

Example:

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

回复收藏 0 原文