javadoc做注释 一. Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /** * ......... * ......... */ javadoc -d 文档存放目录 -author -version 源文件名.java 这条命令编译一个名为 “源文件名.java”的 java 源文件,并将生成的文档存放在“文档存放目录”指定的目录下,生成的文档中 index.html 就是文档的首...
本文转自: http://hi.baidu.com/rover828/blog/item/f77caf01d54454061c958356.html J2SE5中的javadoc.exe的命令行可选参数多达五十余个,其复杂性可想而知,是不是看着头都大了呢?但通常情况下,我们不想那么麻烦! 假设源代码在 C:\src 目录下,其中 com.liigo 是主包,其下可能有数十个子包,数百(千)个Java文件。目录结构大约是这样的: - C:\ | src\ | com\ | liigo\ | *** 怎么才能以最简...
对于Java语言,最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程 序的文档化问题。对于程序的文档化,最大的问题莫过于对文档的维护。若文档与代码分离,那么每次改变代码后都要改变文档,这无疑会变成相当麻烦的一件事 情。解决的方法看起来似乎很简单:将代码同文档“链接”起来。为达到这个目的,最简单的方法是将所有内容都置于同一个文件。然而,为使一切都整齐划一,还 必须使用一种特殊的...
javadoc规范学习! 休息了2天什么也没做,想学习spring很久了,就是没看! 昨天把spring环境在eclipse建起来了,运行了一下感觉还不错!插件还可以,配合myeclipse还是可以开发的! 有弄了一下checkstyle,感觉好的代码规范很重要的!在网上看了看javadoc的规范!又快11点了,生活好无聊啊! 老婆在聊QQ,我也想睡觉了!感觉惰落了!唉! javadoc通常从package、公开类或者接口、公开或者受保护的字段、公开或者受保护的方法提取信...
javadoc的命令行语法如下: javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ] 参数可以按照任意顺序排列。下面分别就这些参数和相关的一些内容进行说明: Packagenames 包列表。这个选项可以是一系列的包名(用空格隔开),例如java.lang java.lang.reflect java.awt。不过,因为javadoc不递归作用于子包,不允许对包名使用通配符;所以你必须显示地列出希望建立文档的每一个包。 Sourcefiles ...
好的程序员是会写文档的程序员,为自己写,也为别人写。 有句话说的好:好的代码是别人能够看懂的代码 文档也在交流中起了非常重要的作用。 你为你的 java 程序写文档乐吗?你知道怎么写 java 文档吗? javadoc 是 java 程序员写文档的标准 javadoc 也是一条命令,可以从你的代码里的文档自动生成 类似 java api document 的文档 其实整个 java api doc 就是用 javadoc 生成的: 下文是两个有关 javadoc 的简单介绍: javado...
利用javadoc制作windows的CHM文档 使用了开源的一个ruby脚本来利用javadoc制作windows的CHM文档。 输出文件编码的时候一定记得选择中文,例如file.puts "Language=0x804 Chinese"。 Ruby代码[code]1.def createProjectFile(prjname, basedir) 2. 3. packages = scanPackageTree(basedir) 4. 5. createContentsFile(prjname+'.hhc', basedir, packages) 6. createIndexFile(prjname+'.hhk', ...
1,javadoc
注释标记 /** */格式
如:
/**
*Title:Killer类
*@author Killer
*@version 1.00
*/
其中
表示换行,但是有@标志会自动换行
下来对Killer构造方法批注
/**
*这是Killer类的构造函数
*@param name Killer的名字
*/
其中@param <参数名称><参数说明>
使用说明:
javadoc -d Killer -version -author Killer.java
-d用来说明它后面跟的是文件存放的位置
-version和 -author说明文件要求加入版本信息和作者信息
还有对哪...
如何个性会从语言、编码、链接、自定义标记、设置版本的自动增加(并引申Eclipse下如何设置SVN中的svn:keywords属性)几个方面来个性你的javadoc文档。 个性分解语言如何设置生成的javadoc默认语言? 解决方案在Eclipse导出javadoc后面的配置VM options中加入-locale en_US,但是此时注意的是,如果把-locale en_US设置在后面的话,会报一个错误,大致是-locale en_US 在javadoc命令必须是在最前面,默认如果不写-locale的话,安装...