JAVA嵌入式文挡介绍

//& ThinkDocDemo.java

import java.util.*;

/** *//** the demo java program.
 * Display now's time and a string
 * @author YanSong Lang
 * @author blog.csdn.net/lang9527
 * @author 郎岩松的注释文挡
 * @version 2.0
*/
public class ThinkDocDemo
...{
/** *//** a public variable*/
    public int vrb;
/** *//** this is public class
 * @param args array of string
 * @exception excepion no exceptions thrown
*/
    public static void main(String[] args)
    ...{
        System.out.println("this is a demo javadoc pragram");
        System.out.println(new Date());
    }
}///&~
    

    如果您对嵌入式文挡并不了解,或根本没有使用过,这没关系,您可以运行上面的代码,通过观察运行结果,您会立刻喜欢上这种嵌入式的文挡.

    所有代码编写者都知道程序嗲吗的编写并不是唯一重要的事情,文挡编写的重要性并不亚于程序代码本身.可其存在的最大问题就是难以维护.如果代码与文挡是分离的,那么每次修改代码时都要修改相应的文挡,这是让人相当头痛的.SUN为我们提供了一个便捷的工具---javadoc.它可将代码中的特殊注释标签解析,并提取这些信息并以HTML的形式输出,也将毗邻注释的类名或方法名抽取出来.这样，我们就可以用少量的工作量,生成相当好的注释文挡.现在我就为大家简单介绍一下如果使用JAVA的嵌入式文挡.

    语法:所有的嵌入式文挡都只能在/**后出现,以*/结尾

常用标签示例:
1@see : 引用其他类.
2@{docRoot} 产生到文挡根目录的相对路径,用于文挡树页面的显示超链接
3@{inheritDoc} 该标签从当前这个类的最直接的基类中继承相关文挡到当前的文挡注释中
4@version 格式为version version-information 编写者潜入的重要信息 javadoc后加
-version
5@author 后跟作者姓名,也可以包含电子邮件等信息 运行时要在javadoc后加-author
6@param 用语方法文挡中,格式为:@param parameter-name description
parameter-name为方法的参数列表中的标识符,description为描述
7@return description description用于描述返回值的含义
8@throws 提示将抛出的异常

    上面8种是比较常用的一些标签示例,注意,javadoc只能为public和protected成员进行文挡注释.private和包内可访问成员的注释会被忽略掉,但可以用其他方法进行标记.还有其他的javadoc参数以及各多的标签示例,想了解更多请查阅相关资料.