初学Java,文档注释(二)

Java 有单行注释,多行注释,这C#都是有的,不过Java还可以生成文档注释,所谓文档注释,就是使用javadoc命令提示符根据你的源码文件类,包等相关的注释生成API文档.

注意,默认情况下只生成public,protected 修饰的内容,如果需要生成private部分,需要增加-private 选项

好像C#里面不能使用储如此类的功能,对C#估计有第三方工具或vs.studio可以生成吧,对这个不了解,猜想的.

下面来使用一下这个生成API文档的功能

在C盘建一个文件夹StudyJava,新建两个java源码文件,Test.java和TestJavadoc.java.

package wangli;
/**
*Description:
*</br>Copyright (C), 2005-2008, Wang.Li.Lee
*</br>This program is protected by copyright laws.
*</br>Program Name:
*</br>Date:
*@author [e-mail]
*@version 1.0
*/
public class Test
{
   /**
    *简单测试属性
    */
   public int age;
   /**
    *Test 类的测试构造器
    */
   public Test()
   {
   }
}

package lee;
/**
*Description:
*</br>Copyright (C), 2005-2008, Wang.Li.Lee
*</br>This program is protected by copyright laws.
*</br>Program Name:
*</br>Date:
*@author [e-mail]
*@version 1.0
*/
public class TestJavadoc
{
   /**
    *简单测试属性
    */
   protected String name;
   /**
    *主方法,程序的入口
    */
   public static void main(String[] args)
   {
      System.out.println("Hello World!");
   }
}

上面建了两个包,lee和wangli

下面看一下javadoc命令怎么用,常用选项有下面几个

-d <directory> : 指定一个路径,用于将生成的API文档放到指定目录下.

-windowtitle<text>: 指定一个字符串,用于设置API文档的浏览器的窗口标题.

-doctitle<html-code>: 该选项指定一个HTML格式的文本,用于指定概述页面的标题

-header<html-code>: 指定一个HTML格式的文本,包含每个页面的页眉

下面是输入命令以后的结果

从上面的命令中,对照看, -d apidoc会在当前目录下生成一个文件夹,用来存放生成的API文档

打开C:\StudyJava\apidoc\index.html, 会发现,命令参数的意义,一下子就全明白了

此API文档,分三个部分,左上图为包列表,左下为类列表,右边是具体信息

选左下角的Test类,右边就会出现Test的具体信息,也就是在源码文件上写的注释,已经生成到文档里面去了

注释里面还可以使用别的标记,上面已经使用了@author,@version.下面还有更常用的@param 方法参数说明信息,@return 方法返回值的说明信息

下面再新建一个java源文件,使用@param和@return,新建名为TestJavadocTag.java的文件,把这个类放在包wangli下面

package wangli;
/**
*Description:
*</br>Copyright (C), 2005-2008, Wang.Li.Lee
*</br>This program is protected by copyright laws.
*</br>Program Name:
*</br>Date:
*@author [e-mail]
*@version 1.0
*/
public class TestJavadocTag
{
   /**
    *@param name 该参数指定向谁打招呼
    *@return 返回打招呼的字符串
    */
   public String hello(String name)
   {
      return name + ",你好!";
   }
}

再看一下生成的API文档

还有一些标记就没必要一个个去试了,需要的时候再查资料吧......