package thinkinginjava.exercise.chapter.one;
/** 使用Java Doc
* 通过Main方法以及类的Java Doc
* @author Thinking In Java
* @author <a href='http://blog.csdn.net/thinkinginjava_07'>Blog</a>
* @version 1.0
*/
public class JavaDoc {
/** JavaDoc类中程序的入口
* @param args 数组类型的字符串参数
* @return 无返回值
* @exception 无异常
*/
public static void main(String[] args) {
System.out.println("Hello Java Doc");//注释
}
}
常用的Java Doc注释:
类:
1. @version
格式如下:
@version 版本信息
其中,“版本信息”代表任何适合作为版本说明的资料。若在 javadoc 命令行使用了 “ - version ”标记,就
会从生成的 HTML 文档里提取出版本信息。
2. @author
格式如下:
@author 作者信息
其中,“作者信息”包括您的姓名、电子函件地址或者其他任何适宜的资料。若在 javadoc 命令行使用了“ -
author ”标记,就会专门从生成的 HTML 文档里提取出作者信息。
可为一系列作者使用多个这样的标记,但它们必须连续放置。全部作者信息会一起存入最终 HTML 代码的单独
一个段落
方法:
1. @param
格式如下:
58
@param 参数名 说明
其中,“参数名”是指参数列表内的标识符,而“说明”代表一些可延续到后续行内的说明文字。一旦遇到
一个新文档标记,就认为前一个说明结束。可使用任意数量的说明,每个参数一个。
2. @return
格式如下:
@return 说明
其中,“说明”是指返回值的含义。它可延续到后面的行内。
3. @exception
有关“违例”( Exception )的详细情况, 我们会在第 9 章讲述。简言之,它们是一些特殊的对象,若某个方
法失败,就可将它们“扔出”对象。调用一个方法时,尽管只有一个违例对象出现,但一些特殊的方法也许
能产生任意数量的、不同类型的违例。所有这些违例都需要说明。所以,违例标记的格式如下:
@exception 完整类名 说明
其中,“完整类名”明确指定了一个违例类的名字,它是在其他某个地方定义好的。而“说明”(同样可以
延续到下面的行)告诉我们为什么这种特殊类型的违例会在方法调用中出现。
4. @deprecated
这是 Java 1.1 的新特性。该标记用于 指出一些旧功能已由改进过的新功能取代。该标记的作用是建议用户不
必再使用一种特定的功能,因为未来改版时可能摒弃这一功能。若将一个方法标记为 @deprecated ,则使用该
方法时会收到编译器的警告。