/**
* JAVA DOC由<b>Java Tag</b>和<b>HTML标记</b>组成。
*
* <br/>
*
* <h3>HTML标记:</h3>
* <ul>
* <li>用来定义注释的格式,大多数HTML标记都支持,常用的有。</li>
* <li>p:段落</li>
* <li>br:换行</li>
* <li>a:超链接</li>
* <li>pre</li>
* <li>b:粗体,如 <b>粗体</b> <u>下划线</u></li>
* <li>code: 代码的标记,仅样式上和不加标记有所区分,如<code>String</code> </li>
* <li>img:支持图片标记。<img src="http://img.alibaba.com/images/cms/upload/banner/partner_bigbuyer/70x25_goodyear.jpg"></li>
* </ul>
*
* <h3>Java Tag:</h3>
* <ul>
* <li>Java Tag用来定义注释的属性,以@开头。</li>
* <li>@link:链接到其他类,如{@link JavaDocRuntimeException}</li>
* <li>@see:为了更加了解当前类,可以去看的其他类或者方法。see标记可以链接到类,方法,URL地址等。</li>
* <li>@value:链接到变量。1.4以后的tag,如 {@value #SCRIPT_START}按住ctrl+鼠标点击,可链接到SCRIPT_START变量</li>
* <li>@code:在code里可以使用特殊字符尖括号等,1.5后的tag,如:<pre>{@code List<String> users=new ArrayList<String>;}</pre></li>
* </ul>
*
* @author tengfei.fangtf
* @version 版本 1.0
*
* @see "javadoc.html"
* @see <a href="spec.html#section">Java Spec</a>
* @see String#equals(Object) equals
* @see <a href="http://download.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html">JavaDoc</a>
*
*/
public class JavaDocDemo {
public static final String SCRIPT_START = "<script>";
/**
* 方法描述
*
* @param doc
* 参数说明
* @return 返回值说明
* @throws JavaDocRuntimeException
* 该方法可能会抛出的异常,如:当长升文档失败时候将抛出JavaDocRuntimeException异常
*/
public String genJavaDoc(String doc) {
try {
} catch (Exception e) {
throw new JavaDocRuntimeException("产生javaDOC失败");
}
return null;
}
/**
* @deprecated 表示当前方法已经不推荐使用,已由新方法取代。
*/
public String genJavaDoc(String doc, String type) {
return null;
}
/**
* JAVA doc运行时异常
*
* @author tengfei.fangtf
*
*/
class JavaDocRuntimeException extends RuntimeException {
private static final long serialVersionUID = 1L;
public JavaDocRuntimeException(String string) {
// TODO 代办任务,表示当前由于时间或者技术原因不能解决的问题,可以在Eclipse的tasks视图下查看
}
}
}
参考资料
http://download.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html
- 大小: 60.6 KB
分享到:
相关推荐
JavaDoc生成API文档(powernode CD2207)(内含教学视频+源代码) 1.1 JavaDoc概述 1.2 文档注释的格式 1.3 IDEA生成API文档 JavaDoc是Java自带的一种工具,其可以从程序源代码中抽取类、方法、属性等注释形成一个和源...
库文件导入就行,src和doc的配置:右键jfreechart-1.0.14.jar,选择属性。如果不明白可以给我留言。或者扣扣:3,4,0,2,7,9,6,2,6
Android API是从Android源代码中提取出Javadoc,做成Chm的PDF电子书
JavaDoc生成API文档(powernode document)(内含源代码和导出的文档) 1.1 JavaDoc概述 1.2 文档注释的格式 1.3 IDEA生成API文档 vaDoc是Java自带的一种工具,其可以从程序源代码中抽取类、方法、属性等注释形成一...
Android API是从Android源代码中提取出Javadoc,做成Chm的pdf电子书
本共享文档中包含org.json.jar包,及其源码 和javadoc文档
lein-javadoc 使用Leiningen为项目中的Java源代码构建Javadoc。用法将[lein-javadoc "0.3.0"]放入project.clj的:plugins向量中。 为了使该插件能够执行任何操作,您需要将配置选项的映射添加到项目映射的:javadoc-...
球菌 是基于的Javadoc Doclet,可让您使用AsciiDoc语法编写Javadoc。执照 介绍传统上,Javadocs将较小的标记与HTML混合在一起,如果您为HTML Javadoc输出而编写,则随着时间的推移,它将变得难以阅读且难以编写。 这...
javadoc插件使用文档
从Kettle 4.1.0源代码生成的JavaDoc
Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成...
Myeclipse导出Javadoc步骤
k8s的Java客户端的帮助文档,从官网代码生成的JavaDoc,版本12.0.0,对应K8S的版本是1.20
JAutodoc是一个能够自动为你的源代码加上Javadoc注释的Eclipse插件。
一个检查 android、androidLibrary、java、javaLibrary 代码源文件 javadoc @author 的插件。 目录介绍 src 下为插件代码。 test-demo 下为测试代码。 原理介绍 利用 javadoc 命令工具的 tools.jar 进行自定义 ...
javadoc利用Java编译程序javac对程序代码源文件中的声明和文档注释进行语法分析,并在默认情况下生成一组HTML文档来描述类、内部类、接口、构造函数、方法和域。不过在运行过程中,它也使用了Java平台的环境变量...
如何用Eclipse创建javadoc,向您介绍如何使用eclipse自动生成doc
是一个很棒的嵌入源代码的工具,但是它需要JavaScript,这意味着它不能与普通IDE的弹出窗口一起使用,并且搜索不到。 由于您可以将单个样本嵌入多个方法/类中并在中心位置管理样本本身,因此Gist使源代码嵌入变得...
最近学习Android,自己找了好久也米有找到比较好的Android API Javadoc文档,于是自己想着自己做一个,去网上下载了Android的java源代码,然后抽取出javadoc,在做成CHM文档,上传上来大家共享下。 可能会有错误,...
使用Eclipse生成javadoc文档的方法