javadoc的用法

《javadoc的用法》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、javadoc的用法说到javadoc,可真是我们开发人员写文档的好东东.1.关于注释// 注释一行/* ...... */ 注释若干行/** ...... */ 注释若干行，可用来写 javadoc 文档我常这么写:引用内容/** * ......... * ......... */这中文档注释必须放在它要注释的类、字段或方法的前面，他们之间不能加别的语句。文档注释分为三个部分:1)概述.一般在注释最前面2)详细说明部分。一般以开头，用以区分概述，换行用。当然还可以加一些修辞的HTML标签，像,等。3)特殊说明部分。@+指令

2、+说明部分组成。指令如下：@author    对类的说明    标明开发该类模块的作者@version    对类的说明    标明该类模块的版本@see            对类、属性、方法的说明    参考转向，也就是相关主题@param    对方法的说明    对方法中某参数的说明@return    对方法的说明    对方法返回值的说明@exception    对方法的说明    对方法可能抛出的异常进行说明---------------------------------------------------

3、---------------------------------------------------@author:      @author 作者名     可用多次@version :      @version 版本号    只能用一次@see:      @see 类名　　@see #方法名或属性名　　@see 类名#方法名或属性名@param：      @param 参数名 参数说明    不会做检查@return：      @return 返回值说明   @exception：　　@exception 异常类

4、名 说明    不会做检查2.javadoc命令行javadoc的用法(2009-03-2813:19:25)转载标签：杂谈javadoc说白了就是为了将JAVA源代码和注释文档化，便于管理不过写注释的人就费事了。基本格式还可以加上@标记 如@author,@see等等。@seeclassname时，如果没有编译相关的包，则不会显示链接javadoc用法：javadoc一堆optionpackage.namesource.namepackage.name二者source.name选其一，或者都选注意这里的package的格式 

5、 详解java源文件涉及到的package问题 在刚开始学java的时候，有很多人搞不清：在java中，含有package的java源文件如何进行编译和执行。我来总结一下：首先建立一个等式(等式为自我定义的,你把full_dir写成whole_dir,globe_dir都无所谓)：或者  (dir:directory)full_dir=base_dir+package_dir    我来解释一下：full_path(full_dir)全路径就是你的*.java源文件所在的整个路径(文件目录)full_path="e:temp

6、srcorgyouwaysamplestest"package_path(package_dir)路径就是在*.java源文件中package部分所编写的路径(文件目录)可以对应package_path="orgyouwaysamplestest"base_path(base_dir)基本路径就是你执行编译或执行命令所在的路径(文件目录)通过等式：full_dir=base_dir+package_dir可得：base_dir=full_dir-  package_dir        ="e:temps

7、rcorgyouwaysamplestest"-  "orgyouwaysamplestest"        ="e:tempsrc"所以，我们选择"e:tempsrc"为编译，运行目录分别调用命令base_dir>javacpackage_dir*.javabase_dir>javapackage_dir*至此，大家是否可明确关于package的基本问题。这是我们以后整体编译调试项目文件的一个基础。在这个问题的背后，其实是jvm如何装载文件的策略问题和格式规定问题。我们在配置classpath时

8、，是否注意那个".;"圆点，那个圆点就是我们所说的base_dir我们如果在使用ant时，是否注意了build.xml的第一行中关于basedir的属性值。