【736c677c4】文档注释生成中文doc方法

转载 2012年03月30日 16:36:23

1.项目-->右键菜单Export-->Java下Javadoc-->next:
<1>javadoc command:就是要调用的javadoc.exe,不用修改,eclipse会找到的;
<2>use standard doclet:就是要生成到的目录,自定义一个文件夹作为存放目录[不然一大堆];
<3>默认即可next-->再next-->
<4>【注意注意】此时如果项目采用的是UTF-8编码,Extra Javadoc options下需要输入设定参数:-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码。
<5>最后Finish完成。
在工程的doc 目录中,就有Javadoc 文档了
-------------------------------------------
如何规范生成JAVADOC帮助文档
1.文本注释(/** */)也叫归档注释。
 归档注释是一种专用注释;当它放在类或类成员声明之前时,javadoc工具可以提取出这些注释并用它们来生成程序的   HTML文档。归档注释通常入在类、接口、方法及字段定义之前。
2.文本注释中的“文档标记”(Doc tags)是一些以“@”开头的命令;
3.javadoc只能为public(公共)和protected(受保护)成员处理注释文档。“private”(私有)和“友好”成员(即没有访问控制符)的注释会被忽略,我们看不到任何输出(也可以用-private标记包括private成员)。

4.类文档标记
类文档可以包括用于版本信息以及作者姓名的标记。

(1)@version
格式如下:
@version 版本信息
其中,“版本信息”代表任何适合作为版本说明的资料。若在javadoc命令行使用了“-version”标记,就会从生成的HTML文档里提取出版本信息。

(2) @author
格式如下:
@author 作者信息
其中,“作者信息”包括您的姓名、电子函件地址或者其他任何适宜的资料。若在javadoc命令行使用了“-author”标记,就会专门从生成的HTML文档里提取出作者信息。
可为一系列作者使用多个这样的标记,但它们必须连续放置。全部作者信息会一起存入最终HTML代码的单独一个段落里。
--------------------------------------
方法文档标记
方法允许使用针对参数、返回值以及异常的文档标记。

(1)@param
格式如下:
@param 参数名 说明
其中,“参数名”是指参数列表内的标识符,而“说明”代表一些可延续到后续行内的说明文字。一旦遇到一个新文档标记,就认为前一个说明结束。可使用任意数量的说明,每个参数一个。

(2)@return
格式如下:
@return 说明
其中,“说明”是指返回值的含义。它可延续到后面的行内。

(3)@exception
有关“违例”(Exception)的详细情况,
 @exception 完整类名 说明
 “完整类名”明确指定了一个违例类的名字,它是在其他某个地方定义好的。
 而“说明”(同样可以延续到下面的行)告诉我们为什么这种特殊类型的违例会在方法调用中出现。

(4) @deprecated该标记的作用是建议用户不必再使用一种特定的功能,因为未来改版时可能摒弃。
 若将一个方法标记为@deprecated,则使用该方法时会收到编译器的警告。

 

       顺便提一下在eclipse下,当鼠标处于类,方法定义行时,按Alt+Shift+J,就可以快速添加文档注释。至于如何导出javadoc文档,eclipse环境下,file > export > javadoc > 这里只要选中你要导出的*.java文件即可,要十分注意的是,通常很多人的classpath环境下,带有 %classpath% 这使javadoc命令无法正确地执行。而提示的出错信息通常是IlleagalArgumentException。

【736c677c4】Js获取当前日期时间及其它操作

var myDate = new Date(); myDate.getYear(); //获取当前年份(2位) myDate.getFullYear(); //获取完整的年份(...
  • slg1988
  • slg1988
  • 2012年03月29日 14:58
  • 370

【736c677c4】jquery uploadify的JS用法以及JAVA类的用法

$(function(){ //$('#uploadify').uploadifySettings('folder','JS'); //动态修改参数 $("#uploadify").uplo...
  • slg1988
  • slg1988
  • 2012年09月16日 14:22
  • 18344

Eclipse文档注释生成doc方法

Eclipse文档注释生成doc方法 1.项目-->右键菜单Export-->Java下Javadoc-->next: javadoc command:就是要调用的javadoc.exe,...

C/C++ Xcode4快速Doxygen文档注释 — 简明图文教程(转)

转自:http://blog.chukong-inc.com/index.php/2012/05/16/xcode4_fast_doxygen/ 准备2个文件: 文件一,Thi...

Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

原文地址:http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html  手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文档...

Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

原文地址:http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html 手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文...
  • ydj213
  • ydj213
  • 2013年07月24日 10:04
  • 1241

IOS学习笔记-9Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

原文转载地址:http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html 手工写文档是一件苦差事,幸好现在有从源码中抽取注释生...

Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

作者:zyl910   手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文档的专用工具。对于Objective-C来说,目前最好用的工具是appledoc和doxygen。可是这两种工具对...

Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文档的专用工具。对于Objective-C来说,目前最好用的工具是appledoc和doxygen。可是这两种工具对于注释的要求略有区别。于是我经...
  • muyu114
  • muyu114
  • 2013年07月24日 17:56
  • 7714

Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文档的专用工具。对于Objective-C来说,目前最好用的工具是appledoc和doxygen。可是这两种工具对于注释的要求略有区别。于是我经...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:【736c677c4】文档注释生成中文doc方法
举报原因:
原因补充:

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