javadoc的用法.doc_第1页
javadoc的用法.doc_第2页
javadoc的用法.doc_第3页
javadoc的用法.doc_第4页
javadoc的用法.doc_第5页
全文预览已结束

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

javadoc的用法说到javadoc,可真是我们开发人员写文档的好东东.1.关于注释/注释一行/*.*/注释若干行/*.*/注释若干行,可用来写javadoc文档我常这么写:引用内容/*.*.*/这中文档注释必须放在它要注释的类、字段或方法的前面,他们之间不能加别的语句。文档注释分为三个部分:1)概述.一般在注释最前面2)详细说明部分。一般以 开头,用以区分概述,换行用。当然还可以加一些修辞的HTML标签,像,等。3)特殊说明部分。+指令+说明部分组成。指令如下:author对类的说明标明开发该类模块的作者version对类的说明标明该类模块的版本see对类、属性、方法的说明参考转向,也就是相关主题param对方法的说明对方法中某参数的说明return对方法的说明对方法返回值的说明exception对方法的说明对方法可能抛出的异常进行说明-author:author作者名可用多次version:version版本号只能用一次see:see类名see#方法名或属性名see类名#方法名或属性名param:param参数名参数说明不会做检查return:return返回值说明exception:exception异常类名说明不会做检查2.javadoc命令行javadoc的用法(2009-03-28 13:19:25) 转载标签: 杂谈javadoc说白了就是为了将JAVA源代码和注释文档化,便于管理不过写注释的人就费事了。基本格式还可以加上标记 如author,see等等。see classname时,如果没有编译相关的包,则不会显示链接javadoc用法:javadoc 一堆option 二者选其一,或者都选注意这里的package的格式详解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:tempsrcorgyouwaysamplestestpackage_path(package_dir)路径就是在*.java源文件中package部分所编写的路径(文件目录)可以对应package_path=orgyouwaysamplestestbase_path(base_dir)基本路径就是你执行编译或执行命令所在的路径(文件目录)通过等式:full_dir = base_dir + package_dir可得:base_dir = full_dir -package_dir= e:tempsrcorgyouwaysamplestest -orgyouwaysamplestest= e:tempsrc所以,我们选择e:tempsrc为编译,运行目录分别调用命令base_dirjavac package_dir*.javabase_dirjava package_dir*至此,大家是否可明确关于package的基本问题。这是我们以后整体编译调试项目文件的一个基础。在这个问题的背后,其实是jvm如何装载文件的策略问题和格式规定问题。我们在配置classp

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论