【转】JavaDoc使用方法(简)

转载 2007年10月11日 10:49:00
首先要养成好的编程习惯
1、在程序的开头,变量的开头,注释都采用如下格式
    /**
      *
      */


然后就可以用javadoc进行文档制作
1、建立需要制作文档的包列表
      新建一个文件packagelist.txt,内容如下:
        com.tju.msnrl.guard.controller
        com.tju.msnrl.guard.db.util
        com.tju.msnrl.guard.db
        com.tju.msnrl.guard.exception
        com.tju.msnrl.guard.util.page
        com.tju.msnrl.guard.util
        com.tju.msnrl.guard.log4j
        com.tju.msnrl.guard.taglib
        com.tju.msnrl.guard.template

2、cmd运行以下命令
      javadoc -d apidoc @packagelist.txt -version -author -footer 天津大学软件学院 -header MSNRL

就可以了^_^
 

java--javadoc--Javadoc转换chm帮助文档的四种方法总结

前言          朋友,当您在一个项目完成后,是不是需要把你的源码打包并且把注释打成Javadoc交给客户,Eclipse或者MyEclipse自动打成的Javadoc文档都是基于网页格式的,...
  • liwenjie001
  • liwenjie001
  • 2013年12月26日 11:58
  • 2240

JAVADOC有关命令简析

JAVADOC 相关标记: @author ->标记作者 @version ->标记软件版本 @deprecated ->标记不建议使用 @param ->标记参数信息 @return ->标记返回值...
  • LUANJIESHI
  • LUANJIESHI
  • 2015年07月28日 15:11
  • 204

Javadoc文档注释使用方法

在Java里面主要有三种注释:行注释、段落注释、文档注释 这里主要说第三种:文档注释 文档注释是Java里面的一个比较厉害的功能,它可以用于注释类、属性、方法等说明,而且通过JDK工具javado...
  • Listener_ri
  • Listener_ri
  • 2015年04月22日 09:27
  • 4844

Javadoc转换chm帮助文档的四种方法总结

Javadoc转换chm帮助文档的四种方法总结                                                                             ...
  • Fupengyao
  • Fupengyao
  • 2016年06月03日 16:31
  • 2260

JavaDoc生成API详解

开发者文档(API)应该在开发的同时在代码中写好,这就是使用Javadoc的原因。每一个Java程序员都应该熟练掌握。...
  • fanxiaobin577328725
  • fanxiaobin577328725
  • 2016年09月25日 11:02
  • 5943

utf-8项目生成javadoc时,报错: 编码GBK 的不可映射字符

这是因为:由于JDK是国际版的,在编译的时候,如果我们没有用-encoding参数指定我们的Java源程序的编码格式,则javac.exe首先获得我们操作系统默认采用的编码格式,也即在编译java程序...
  • u012052268
  • u012052268
  • 2017年02月19日 22:32
  • 294

如何最方便的查看javadoc

www.docjar.com是一个javadoc的搜索引擎,别的不说,只看界面就知道这些jar都是手工搜集而成(lastest updates),世界上已有的jar和新版本的jar就凭手工收集是无论...
  • u013497460
  • u013497460
  • 2014年03月04日 23:47
  • 1506

eclipse设置本地Javadoc API路径

在线的javadoc访问地址: http://download.oracle.com/javase/7/docs/api/   javadoc(JDK 7 Documentation)下载地址:...
  • D_reamW_eaver
  • D_reamW_eaver
  • 2013年07月12日 15:31
  • 1320

你不知道的Eclipse用法:使用Javadoc导出项目的API文档

使用Javadoc导出项目的API文档
  • ZJDWHD
  • ZJDWHD
  • 2016年08月31日 15:32
  • 1827

javadoc注释模板设置及详解

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一...
  • projectNo
  • projectNo
  • 2017年08月01日 10:02
  • 441
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:【转】JavaDoc使用方法(简)
举报原因:
原因补充:

(最多只允许输入30个字)