java中的注释文档

在前两次的博客中，首先介绍了java是什么？第二部就是怎么创建，第三步是如何保存，接下来第四步static的用法。这篇博客记录一下自己学习Java编程思想这本书第一遍的java注释文档。

一、三种注释方式

1、使用//的注释方式

这个很简单，就是在//之后填写自己的要注释的内容，也是我自己目前最常用的一种方式，这个方式适用于2单行注释。

2、使用/* 内容 */

这个也很好理解，就是在内容区域用/* 和*/括起来。在里面填写自己的注释内容，这个方式适用于多行注释。

3、使用javaDoc文档进行注释

先看一下出现的问题：

        我们在编写代码时候，代码的维护是最大的问题。如果我们的文档和代码是分离的，那么每一次修改代码时候，必须要修改相应的文档，这样就会很不方便。为了能够解决这个缺陷，为此我们的做法是：将代码和文档链接起来

再看如何解决

       为了达到代码和文档链接起来的目的。

1、将所有的东西放在同一个文件夹里面

2、使用一种特殊的语法来标记文档

3、使用工具来提取这些注释文档

   意思就是，我们把有特殊语法的注释和代码写在一起，然后使用工具提取出来。 为此，javadoc便应用而生了，它输出的是一个html文档。

  接下来看一个例子：

import java.io.*;
 
/**
* 这个类演示了文档注释
* @author 张三
* @version 1.2
*/
public class SquareNum {
   /**
     一个int型变量
    */
    int a=0;

   /**
   * @param num The value to be squared.
   * @return num squared.
   */
   public double square(double num) {
      return num * num;
   }

   /**
   * This method demonstrates square().
   * @param args Unused.
   * @return Nothing.
   * @exception IOException On input error.
   * @see IOException
   */
   public static void main(String args[]) throws IOException
   {
   }
}

从上面的例子可以看到，一共有三种类型的注释文档，分别对应于注释位置后面的三种元素类、域、方法。

注意： javadoc只能为public和protected成员进行注释。如果是私有类型的则提取的时候会被忽略掉。

2、在注释文档中，每一行开头的星号和前面的空格都会被自动忽略掉，javadoc会对所有的内容重新2进行格式化，

3、不要在嵌入式HTML中使用标题标签，javadoc会插入自己的标签，而自己的标签会发生冲突。

最后看一下语法标签

标签	描述	示例
@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

4、使用工具提取javadoc

这里有已经使用javadoc语法的代码

public class Test {

	public static void main(String[] args) {
		System.out.println("example");
		
	}
	 
	/**
	 * 
	 * @author duan
	 * @version 1.0
	 * 这个类用来测试javadoc
	 * 在这个地方编写类说明
	 *
	 */
	public class TestDoc {
		/**
		 * name是一个字符串，内容是javadoc
		 */
		public String name= "javadoc";
		public TestDoc(String name){}
		
		/**
		 * 这个方法改变类域中的name
		 * @param name 设置的名字
		 * @return 没有返回值
		 */
		public String setname(String name){
			this.name = name;
			return name;
		}
	}

}

 使用Myeclipse：点project-generate javadoc就可以一步一步生成了。打开自己生成的位置

 进入之后的结果形式如下：