|
|
作者：桂静秋
日期：2003年1月3日
在jdk里面有个命令javadoc,它的作用就是通过你的代码生成相应的说明文档，在javadoc里面有很多option，用要好它也真是麻烦！不如我们用JB来生成吧!:)
首先我们建立一个project,任意编写一段代码，如下：
- package com.gjq;
-
- /**
- * 我的测试类
- * <p>Title: example</p>
- * <p>Description: 做一个例子而已</p>
- * <p>Copyright: Copyright (c) 1.1</p>
- * <p>Company: abc</p>
- * @author gjq
- * @version 1.0
- */
- public class A {
-
- /**
- * 构造
- */
- public A()
- {}
-
- /**
- * 保持信息
- */
- private String msg;
-
- /**
- * 写入信息
- * @param msg 信息参数
- * @return 如果写成功就返回true 否则 false
- */
- public boolean write(String msg)
- {
- if (msg != null)
- {
- if (!msg.trim().equals(""))
- {
- this.msg=msg;
- return true;
- }
- }
- return false;
- }
-
- /**
- * 读信息
- * @return 返回读出的内容
- */
- public String read()
- {
- return (msg == null?"":msg);
- }
-
- /**
- * 打印信息
- */
- public void speak()
- {
- System.out.println(msg);
- }
- }
是不是看到有很多象/**……………*/中间扩了很多东西？里面会有@return或者@param，这个不用担心，JB可以帮自动生成。你只要在一个空行后面打/**然后Enter它就可以帮你生成剩下的。其实当你按doc标签就可以看到javadoc，但是不是很系统的，不象我们下载的文档一样。
现在开始做，首先
接着可以选择要标准的doc还是老的jdk1.1
完成后在rebuild一次，你将可以看到
然后你在你的项目目录里面就可以看到
打开index.html就可以看到你做的javadoc了！
 (在例中我多写了个B Class，所以多个B Class)
其它
以上只是简单的说了说在jb里面做个JavaDoc的过程，如果你想再深入的了解可以看相关的文档，里面有挺多标记如@see and @throws等(在IntelliJ IDEA里面写程序注释真是“可恶”，当你打个@时什么东西都弹出来给你选择，真是太方便了)，另外在javadoc中支持html，你可以充分美化你的doc.
|
|
