|
5楼 傲世乾坤。说: ????在?Java?的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序,所以我们需要进行一些注释,可以是编程思路或者是程序的作用,总而言之就是方便自己他人更好的阅读。
????Java语言的注释我们主要了解三种:单行注释、多行注释、文档注释
单行注释
????单行注释也起源于C++,以一个“//”起头,表示这一行的所有内容都是注释。这种类型的注释更常用,因为它书写时更方便。没有必要在键盘上寻找“/”,再寻找“*”(只需按同样的键两次),而且不必在注释结尾时加一个结束标记。下面便是这类注释的一个例子:
????//?这是一条单行注释
多行注释
????Java里有两种类型的注释。第一种是传统的、C语言风格的注释,是从?C++继承而来的。这些注释用一个“/*”起头,随后是注释内容,并可跨越多行,最后用一个“*/”结束。注意许多程序员在连续注释内容的每一行都用一个“*”开头,所以经常能看到象下面这样的内容:
????/*?这是
????一段注释,
????它跨越了多个行?*/
????但请记住,进行编译时,/*和*/之间的所有东西都会被忽略,所以上述注释与下面这段注释并没有什么不同:
????/*?这是一段注释,它跨越了多个行?*/
文档注释
????Java文档注释是一种功能强大的注释形式,如果在你所编写的程序中规范的添加文档注释,那你就可以生成一份系统正规的API文档。Java文档注释?/**文档注释内容*/,注意区分多行注释/*多行注释*/。
????Java使用javadoc工具提取注释,生成十分专业的程序文档。javadoc输出的是一个HTML文件,可用自己的Web浏览器查看。由于有了jvadoc,所以我们能够用标准的方法创建文档。而且由于它非常方便,所以我们能轻松获得所有Java库的文档。
????标签 描述 示例
????@author 标识一个类的作者 @author?description
????@deprecated 指名一个过期的类或成员 @deprecated?description
????{@docRoot} 指明当前文档根目录的路径 Directory?Path
????@exception 标志一个类抛出的异常 @exception?exception-name?explanation
????{@inheritDoc} 从直接父类继承的注释 Inherits?a?comment?from?the?immediate?surperclass.
????{@link} 插入一个到另一个主题的链接 {@link?name?text}
????{@linkplain} 插入一个到另一个主题的链接,但是该链接显示纯文本字体 Inserts?an?in-line?link?to?another?topic.
????@param 说明一个方法的参数 @param?parameter-name?explanation
????@return 说明返回值类型 @return?explanation
????@see 指定一个到另一个主题的链接 @see?anchor
????@serial 说明一个序列化属性 @serial?description
????@serialData 说明通过writeObject(?)?和?writeExternal(?)方法写的数据 @serialData?description
????@serialField 说明一个ObjectStreamField组件 @serialField?name?type?description
????@since 标记当引入一个特定的变化时 @since?release
????@throws 和?@exception标签一样. The?@throws?tag?has?the?same?meaning?as?the?@exception?tag.
????{@value} 显示常量的值,该常量必须是static属性。 Displays?the?value?of?a?constant,?which?must?be?a?static?field.
????@version 指定类的版本 @version?info
????说明注释:
????在开始的/**之后,第一行或几行是关于类、变量和方法的主要描述.
????之后,你可以包含一个或多个何种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*).
????多个相同类型的标签应该放成一组。例如,如果你有三个@see标签,可以将它们一个接一个的放在一起。
代码示例
????请看含有所有注释的HelloWord例子:
折叠
复制
行号
运行
调试
/*** 这个类主要介绍如何学习注释,我是文档注释
* @author honey_11
* @version 1.0
*/
public class HelloWord {
//这是单行注释,我在方法前面,main函数是入口函数
public static void main(String[] args){
/*
我里面的内容都是多行注释
System.out.println("我被注释了,我不会被编译和执行");
*/
System.out.println("Java学习手册");
// System.out.println("我被注释了,我不会被编译和执行");
}
/**
* 求两个数的差的方法,我也是文档注释
* @param a 参数被减数
* @param b 参数减数
* @return 返回两个数的差
*/
public int minus(int a,int b){
return a-b;//这也是单行注释,返回a-b的差
}
}
????运行结果:
????Java学习手册
javadoc生成步骤
????点击eclipse的【Project】菜单,选择【Generate?JavaDoc】选项。
????(1)选择您要生成JavaDoc的工程
????(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。
????(3)选择doc的生成位置,默认为工程目录下,建议不要修改。
????(5)点击【Next】按钮
????(1)勾选Document?Title,然后填写文档标题。
????(2)点击【Next】按钮
????(1)选择使用的jdk版本
????(2)点击【Finish】按钮
????可以看到控制台输出生成javadoc的信息。
????项目下生成一个【doc】的目录,里面存放着javadoc文档。
????打开doc目录,用浏览器打开index.html
????可以看到一个完整的API文档、javadoc就生成了。
本帖来自安卓秘书 |
|