2、注释

为什么用注释

注释是为了方便程序的阅读,java语言允许程序员在程序中写上一些说明性的文字,来提高程序的可读性,这些文字是注释。 但是注释不会出现在字节码文件中,就是说:java编译器在编译的时候会跳过注释的语句。而java根据注释的功能不同,能分为三种注释,单行注释、多行注释、文档注释。

单行注释

单行注释:以“//”开头,//后面的内容都为注释。

多行注释

多行注释:以“/”开头,以“/”结尾,在这之间的内容都为注释,多行注释的内容可以非常的灵活,可以在做为行内注释。

文档注释

文档注释:以“/**”开头,以“*/”结尾,注释中包含一些说明性的文字,及一些javaDoc的标签(可以生成API)

用文档注释成生一个API

就用上面的那一个Hello.java吧,然后再复制出来一个类World.java

用这两个类来进行测试:

1、在测试前必须先把这两个类的编码转换为GBK,不然javaDoc识别不了。
  2、进入到想要生成API的类的目录里面。点击这里:输入cmd进入到当前文件夹为根目录的命令行里面:

3、在命令行里面输入

javadoc -d api_doc -windowtitle 测试API -doctitle zhushi -header GFrost的类 *.java

看到这个页面就是生成好了。在当前目录里面。

下面是效果:

下面中javadoc的常用的标记

  • @author:指定Java程序的作者
  • @version:指定源文件的版本
  • @depreated:不推荐使用的方法
  • @param:方法的参数说明信息
  • @return:方法的返回值说明信息
  • @see:“参见”,用于指定交叉参考的内容
  • @exception:抛出异常的类型
  • @throws:抛出的异常,和@exception同义

使用时的注意是:

javadoc工具只能处理文档源文件在类、接口、方法、成员变量、构造器和内部类之前的文档注释,别的地方的文档不处理。
  默认的时候,只处理public 和 protected 上面的注释,而对别的不管,如果想让私有方法也加入到API文档中,请在命令上面加上 (-private)

参考:
Undergoer_TW





细节决定成败!

个人愚见,如有不对,恳请扶正!

猜你喜欢

转载自www.cnblogs.com/xdtg/p/12308452.html