java版权注释

❶ java 文档注释是注释什么的,不是有多行注释了吗

1、【文档注释】是写在类或者方法的上面的。

文档注释可以用eclipse导出chm格式的帮助文档，拿给其他人用时，方便他人理解。文档注释被调用的方法，当鼠标移到上面时提醒注释内容。

使用文档注释时，需要在开始的/**之后，第一行或几行是关于类、变量和方法的主要描述。

之后，可以包含一个或多个何种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。

2、【多行注释】注释的也是方法或类，言下之意就是一次性的将程序中的多行代码注释掉，但多行注释的内容不能用于生成一个开发者文档。

3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档，而文档注释 的内容可以生产一个开发者文档。

(1)java版权注释扩展阅读

java常用的文档注释标签

1、@author：标识一个类的作者

实例：@author description

2、@deprecated：指名一个过期的类或成员

实例：@deprecated description

3、@exception：标志一个类抛出的异常

实例：@exception exception-name explanation

4、{@inheritDoc}：从直接父类继承的注释

实例：Inherits a comment from the immediate surperclass.

5、{@link}：插入一个到另一个主题的链接

实例：{@link name text}

6、{@linkplain}：插入一个到另一个主题的链接，但是该链接显示纯文本字体

实例：Inserts an in-line link to another topic.

7、@param：说明一个方法的参数

实例：@param parameter-name explanation

8、@return：说明返回值类型

实例：@return explanation

9、@see：指定一个到另一个主题的链接

实例：@see anchor

10、@serial：说明一个序列化属性

实例：@serial description

❷ java 注释规范

/**
*方法功能描述
*
*@param参数说明
*@author作者
*@return返回格式
*@exception异常
*/

❸ java中 /** */注释和 /* */注释 有啥区别吗

/** */注释的话，你再调用类和方法的时候会出现提示，内容就是你写的注释。就好像文档帮助一样。类似"字符串".toString()，鼠标放在toString()上时出现的api说明。
而/* */就没有了。/* */就是//的多行版

❹ java中注释的问题

DOC注释/**------*/是完全为javadoc服务的会被编译识别。

@打头的表示注解，注解这个东西是JDK1.5提出来的，表示一个类(class)、字段(field)或者方法(method)的属性(attribute)。

javadoc是javaAPI的一种方便实现，主要是为了别人对此类的阅读使用的方便，一般不影响类的功能。因为java之前的C/C++的api让你阅读起来非常不方便。

DOC注释里面的专门给出doc提示用的，如：注释内的@return 表示方法的返回值类型，它是在方法上的doc注解，即使你这个上面随便瞎写，不会影响类的编译和功能。

而在方法上面直接加的@Override，表示这个方法是覆盖来自超类(super class)的已知方法。
如果方法定义和超类的这个方法格式不合适，编译无法通过。

❺ java注释

各公司都有不同要求，一般方法注释需要注明该方法的作用，参数说明和返回值。有异常的要加异常说明。有时还要加上创建人，修改人和修改时间。
/**
* 对数组进行排序
* @author XXX
* @param 待排序数组
* @return 排序后的数组
*/

❻ 真正的开发中，java代码要如何注释

代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在诉求网二期开发中使用的代码注释规范，供大家参考下。
原则：
1、注释形式统一
在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。
2、注释内容准确简洁
内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。
注释条件：
1、基本注释（必须加）
(a) 类（接口）的注释
(b) 构造函数的注释
(c) 方法的注释
(d) 全局变量的注释
(e) 字段/属性的注释
备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或VO对象的getter、setter方法不需加注释。具体的注释格式请参考下面举例。
2、特殊必加注释（必须加）
(a) 典型算法必须有注释。
(b) 在代码不明晰处必须有注释。
(c) 在代码修改处加上修改标识的注释。
(d) 在循环和逻辑分支组成的代码中加注释。
(e) 为他人提供的接口必须加详细注释。
备注：此类注释格式暂无举例。具体的注释格式自行定义，要求注释内容准确简洁。
注释格式：
1、单行(single-line)注释：“//……”
2、块(block)注释：“/*……*/”
3、文档注释：“/**……*/”
4、javadoc 注释标签语法
@author 对类的说明标明开发该类模块的作者
@version 对类的说明标明该类模块的版本
@see 对类、属性、方法的说明参考转向，也就是相关主题
@param 对方法的说明对方法中某参数的说明
@return 对方法的说明对方法返回值的说明
@exception 对方法的说明对方法可能抛出的异常进行说明

❼ 什么是注释如何在Java程序中加入注释

试想一下，一个没有一句注释的程序源码，怎么读，一个程序要上万条代码不可能全部记得住哪一块是什么用，而且一个项目也不会是一个人独自完成，那样效率太低，多人合作就要给别人说明，每一块是什么用，方便他人使用，方便自己更正，而这些说明文字就是注释，注释不会被执行，不影响运行结果。

Java中代码的注释有三种：

// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行，并写入 javadoc 文档

前两种比较容易理解，至于第三种，你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。

(7)java版权注释扩展阅读

注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。

❽ java开发时怎么自动添加注解

想要自动添加注释，首先需要对eclipse进行一些设置。

打开Eclipse,然后点击->windows->preferences->Java->code styles->code templates->comments->types->点击右侧的edit进行编辑，在打开的编辑窗口中修改下面的文字

/**
* @author ${user}
*
* ${tags}
*/
替换成

/**
* @author 你的名字
*
* ${tags}
*/
上面的操作对应的图片是这样的:

这样作者就修改成你的名字了，更多的信息可以点击本编辑窗口上面的insert varibles按钮，会弹出一些文件名称，项目名称等参数，你可以选择性地添加到你的注视中。

然后在你的类中，你只要敲入/**然后换行，注释就自动滴添加到你的代码中了~希望能帮上你的忙~^_^

追问：
这只是文档前的版权声明注释，如果要在文档中对代码添加注释，里面带上修改时间，如何弄
回答：
这样弄哈~
1.开始还是打开Eclipse,然后点击->windows->preferences->Java->code styles->code templates->comments

2.下一步选择methods，而不是types。然后edit，insert varibles，添加上date变量，长下面这个样子。

然后你在你的函数上面同样是敲入/**回车，就出现了修改的日期了

补充：
对于那个行首出现注释的问题是java的代码风格的问题，可以这样改
打开Eclipse,然后点击->windows->preferences->Java->code styles->formatter
->edit->comment 的标签页->never indent line comments on first column
这样，注释的//就会缩进了，而不是顶在行首了~

❾ java 中的几种注释方式

我看动力节点的java基础大全301集教中的三种注释方法：

1、单行注释 //注释的内容

2、多行注释/*......*/

3、/**......*/，这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。

下面介绍一下Javadoc的标记：

特别声明：

（1）javadoc针对public类生成注释文档

（2）javadoc只能在public、protected修饰的方法或者属性之上

（3）javadoc注释的格式化：前导*号和HTML标签

（4）javadoc注释要仅靠在类、属性、方法之前

下面主要举例说明第三种注释的应用：

（1）首先编写.java文件

（2）在命令行中执行以下dos命令：

javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档

//javadoc标记：是@开头的，对javadoc而言，特殊的标记。

（3）在当前目录下就会产生doc文件夹，里面有一系列的.html文件

附上代码：

[java]view plain

• <spanstyle="font-size:18px;">*/

• /**javadoc注释的内容

• */

• publicclassHello{

• /**属性上的注释*/

• publicStringname;

• /**这是main方法,是程序的入口

• *@paramargs用户输入参数

• */

• publicstaticvoidmain(String[]args){

• System.out.println("HelloWorld!");

• f1();

• }

• /**这是第1个方法,其作用是...*/

• publicstaticvoidf1(){

• System.out.println("f1()！");

• }

• }</span>

[java]view plain

• <spanstyle="font-size:18px;">importjava.io.IOException;

• /**javadoc注释内容

• *@since1.0

• *@version1.1

• *@authorBlueJey

• *<br>链接到另一个文档{@linkHello},就这些

• *seeHello

• */

• publicclassHelloWorld{

• /**非public，protected属性上的注释不生成*/

• publicStringname;

• /**这是main方法，是程序的入口

• *@paramargs用户输入的参数，是数组

• *@throwsIOExceptionmain方法io异常

• */

• publicstaticvoidmain(Stringargs[])throwsIOException{

• System.out.println("helloWorld!");

• f1();

• f2(1);

• }

• /**这是第一个方法，其作用是....

• *@deprecated从版本1.2开始，不再建议使用此方法

• */

• publicstaticvoidf1(){

• System.out.println("fl()!");

• }

• /**这是第二个方法，其作用是....

• *@return返回是否OK

• *@parami输入参数i

• *@seeHello

• *@throwsIOExceptionio异常

• */

• publicstaticStringf2(inti)throwsIOException{

• System.out.println("f1()!");

• return"OK";

• }

• }</span>

注意：

如果源文件中有用到@version,@author标记，则在执行javadoc命令时，要加-version-author

javadoc-version-author-ddoc*.java

（其中用-version用于提取源文件中的版本信息-author用于提取源文件中的作者信息）

❿ JAVA的注释问题

两种可能：
1.项目引用了别人的源码，用这种方式可以表示尊重对方的版权，通常可能楼主也遇到过就是我们去一些别的博客或者站点看文章的时候，文章的开头或者结尾都有一句提示说“如转载，请注明文章来自于XXX”对吧，源码也是如此，因为生成doc后这段注释代码会存在于doc中，这样的话源码的所有者只要源码是开源的并且尊重了这种声明协议，也就不会再追究责任了。
2.自己的项目头，通常使用的一些团队开发软件比如cvs或者开发ide在你新建一个类的时候自动产生这段代码，说明源码的公司等信息。