‘壹’ java中文档注释各字段的含义是什么例如author表示作者,para表示参数等
常用Java注释标签(Java comment
tags)
@author 作者
适用范围:文件、类、方法
(*多个作者使用多个@author标签标识,java
doc中显示按输入时间顺序罗列。)
例:*
@author Leo. Yao
@param 输入参数的名称 说明
适用范围:方法
例:* @param str
the String用来存放输出信息。
@return 输出参数说明
适用范围:方法
例: *
@return <code>true</code>执行成功;
* <code>false</code>执行失败.
@since
JDK版本
用于标识编译该文件所需要的JDK环境。
适用范围:文件、类
例: * @since
JDK1.6
@version 版本号
用于标识注释对象的版本号
适用范围:文件、类、方法
例: * @version 1.0
@see 链接目标
表示参考。会在java 文档中生成一个超链接,链接到参考的类容。使用中的感觉是@see不需要包路径,对我这种懒人比较喜欢,相对{@link
}这种既要加大括号,有需要包路径,我还是选择偷懒,当然你要是不介意使用import导入要link的类,那就可以达到@see的效果,所以总体来说,还是选择@see,当然两个在特殊场合下还是用法不一样的
用法:
@see
#field
@see #Constructor(Type,
Type...)
@see #Constructor(Type id, Type
id...)
@see #method(Type,
Type,...)
@see #method(Type id, Type,
id...)
@see
Class
@see
Class#field
@see Class#Constructor(Type,
Type...)
@see Class#Constructor(Type id,
Type id)
@see Class#method(Type,
Type,...)
@see Class#method(Type id, Type
id,...)
@see
package.Class
@see
package.Class#field
@see
package.Class#Constructor(Type, Type...)
@see
package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type,
Type,...)
@see package.Class#method(Type
id, Type, id)
@see
package
@throws 异常
标识出方法可能抛出的异常
适用范围:方法
例: * @throws IOException If an input or output
exception occurred
@deprecated 解释
标识对象过期
适用范围:文件、类、方法
@link 链接地址
链接到一个目标,用法类似@see。但常放在注释的解释中形如{@link …}
例:
/**
* @deprecated As of JDK 1.1,
replaced by
* {@link
#setBounds(int,int,int,int)}
*/
‘贰’ 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、【文档注释】是写在类或者方法的上面的。
文档注释可以用eclipse导出chm格式的帮助文档,拿给其他人用时,方便他人理解。文档注释被调用的方法,当鼠标移到上面时提醒注释内容。
使用文档注释时,需要在开始的/**之后,第一行或几行是关于类、变量和方法的主要描述。
之后,可以包含一个或多个何种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。
2、【多行注释】注释的也是方法或类,言下之意就是一次性的将程序中的多行代码注释掉,但多行注释的内容不能用于生成一个开发者文档。
3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档,而文档注释 的内容可以生产一个开发者文档。
(3)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注释中的<code></code>标记作用是什么
java注释中的<code></code>标记表示代码的标记。
既然是出现在注释中,那么程序是不会执行和解析的。
而这种写法通常是由程序开发人员沿用了html或者jsp里面的标签的格式,用来写注释内容,从而方便在以后能直观看出当前程序的功能。
‘伍’ java注释里的这些标记分别是什么意思详细点
<code> 标签用于表示计算机源代码或者其他机器可以阅读的文本内容。
<tt> 标签呈现类似打字机或者等宽的文本效果。
<p> 标签定义段落。
<i> 标签显示斜体文本效果。
<a> 标签定义超链接,用于从一张页面链接到另一张页面。
详细信息请参考http://www.w3school.com.cn/,网址里面有各种表情详解及使用教程。
‘陆’ java里,jsp页面怎么注释含标签的语句
有两种方式:一是html方式注释,而是jsp方式注释。
html方式注释:在jsp标签的左右尖括号中添加注释语句。(下面注释了c:out标签)
<!--c:out...-->
sp方式注释:把要注释的内容用jsp代码标记包含并注释:
<%/*
<c:out...>
*/%>
推荐第二种,因为第一种会将你的代码暴露在最终的html中,而且也增加了页面大小。
‘柒’ Java 文档注释中的几个Tag标记
<code></code> 标签用于表示计算机源代码或者其他机器可以阅读的文本内容
<tt></tt> 标签呈现类似打字机或者等宽的文本效果。
<p> 一个段落,每个段落之间一般会有一个空行。
<i></i> 标签显示斜体文本效果
<a></a> 增加链接
‘捌’ Java如何进行单行注释和多行注释
(1)单行注释:以“ // ”开头后面接所要加的说明的内容。如下面所示: //定义变量a int a = 10; //定义变量b int b = 20;上面的语句中,在编译的过程就会直接略过注释,只会编译 int a = 10 和 int b = 20这两句。由此可见注释只是起着说明的作用。
(2)多行注释:以“/*”开头,以“*/”结尾。 假设当你要说明你所写的代码的功能时。要说明的内容有很多。如果全部放在同一行会显得很难看。所以一般会用多行来写,如下所示// 说明//说明//说明//说明以上是用四个单行注释来注释四行说明。但如果有10行说明就要按十个“//”这显示很麻烦,所以这时就可采用多行注释。上面的可改成:/*说明说明说明说明*/也可以这样/* 说明 说明 说明 说明 */
(3)文档注释:以“/**”开头,以“*/”结尾。文档注释主要是生成文档的。
‘玖’ java 中/**是什么
你的j2se只学了一点而已,不管怎样,都要先把j2se学好,这是基础。j2se的学习顺序一般是这样的:基础语法 -> 面向对象入门 -> 异常处理 -> 数组 -> 常用类 -> 容器(相当重要) -> IO -> 线程 -> 网络 -> GUI。
既然你io,thread都学了,其余那些还有没学的,建议去看看马士兵的j2se视频,其实我觉得如果想打好基础的话,这套视频应该全部过过,特别是开始的内存分析和面向对象分析。学完j2se要做做几个基础的桌面项目,像什么贪吃蛇啊、俄罗斯方块、简单的聊天器等等,这样才能把知识整合起来,加深对j2se的理解。
如果想走j2ee路线的话,接下来应该学数据库,再学html、css、JavaScript、jsp/servlet,也就是web的入门,之后做做web项目,比如小bbs、网上商城等等。学通了就学框架,这期间会穿插很多东西,例如xml、uml、log4j、jUnit等等,最后学设计模式和面向对象的分析。计算机的东西是很多的,不要学死,也不要想着学完,最重要的是学会解决问题的方法。开始肯定要模仿别人的代码,不断模仿,多看,看完一定要自己写几遍,只有能写出来了的,才是自己的东西,建议开始时多背点东西,包括一些常用类啊、一些概念性的东西,因为背多了自己就熟悉了。
数据库的要另找,网上能找到马士兵的Oracle,讲的很不错的!!
shopping这个项目也有从头带到尾的,也是马士兵的,要找找
做项目是很重要的,从简单的做起,慢慢体会其中的分析与设计
学java还是从视频入门的好,千万不要一开始就去看《Thinking in java》,吃力不讨好,学到web时可以看看张孝祥的《深入体验JAVA Web开发内幕——核心基础》,写的很详细,不过他的视频一般,JavaScript就看《JavaScript高级程序设计》,html比较简单,css也比较简单,不过css布局因人而异,有人觉得很好理解,有人觉得很难,搞个Dreamweaver多练练也就熟悉了。设计模式可以看《大话设计模式》,入门很好!
你的j2se只学了一点而已,不管怎样,都要先把j2se学好,这是基础。j2se的学习顺序一般是这样的:基础语法 -> 面向对象入门 -> 异常处理 -> 数组 -> 常用类 -> 容器(相当重要) -> IO -> 线程 -> 网络 -> GUI。
既然你io,thread都学了,其余那些还有没学的,建议去看看马士兵的j2se视频,其实我觉得如果想打好基础的话,这套视频应该全部过过,特别是开始的内存分析和面向对象分析。学完j2se要做做几个基础的桌面项目,像什么贪吃蛇啊、俄罗斯方块、简单的聊天器等等,这样才能把知识整合起来,加深对j2se的理解。
如果想走j2ee路线的话,接下来应该学数据库,再学html、css、JavaScript、jsp/servlet,也就是web的入门,之后做做web项目,比如小bbs、网上商城等等。学通了就学框架,这期间会穿插很多东西,例如xml、uml、log4j、jUnit等等,最后学设计模式和面向对象的分析。计算机的东西是很多的,不要学死,也不要想着学完,最重要的是学会解决问题的方法。开始肯定要模仿别人的代码,不断模仿,多看,看完一定要自己写几遍,只有能写出来了的,才是自己的东西,建议开始时多背点东西,包括一些常用类啊、一些概念性的东西,因为背多了自己就熟悉了。
数据库的要另找,网上能找到马士兵的Oracle,讲的很不错的!!
shopping这个项目也有从头带到尾的,也是马士兵的,要找找
做项目是很重要的,从简单的做起,慢慢体会其中的分析与设计
学java还是从视频入门的好,千万不要一开始就去看《Thinking in java》,吃力不讨好,学到web时可以看看张孝祥的《深入体验JAVA Web开发内幕——核心基础》,写的很详细,不过他的视频一般,JavaScript就看《JavaScript高级程序设计》,html比较简单,css也比较简单,不过css布局因人而异,有人觉得很好理解,有人觉得很难,搞个Dreamweaver多练练也就熟悉了。设计模式可以看《大话设计模式》,入门很好!
‘拾’ java注释里的这些标记分别是什么意思
方法/步骤
java注释,总共有3种注释方法。
注意事项
注释内容是不被编辑的内容,只是解释说明
注释,为了更方便的阅读
每次单行注释、多行注释,要选中要注释的内容