javadoc定义异常_Doclava:来自Google的自定义Javadoc Doclet
javadoc定义异常
这是Doclava和标准Doclet之间的主要区别:
- 刷新后的外观,包括搜索功能。
- 将版本信息嵌入文档中。
- 使用模板引擎进行用户自定义。
- 为容易捕获的内容引发构建错误,例如与参数名称不匹配的@param标记。
- 能够包含来自真实源代码的代码片段
- 多个站点之间的联合文档。
- 能够将Javadocs嵌入更大的网页中。
将Doclava与Javadoc结合使用
-doclet com.google.doclava.Doclava -docletpath ${jar.file}
将Doclava与Ant结合使用
<project>...<target name="doclava" depends="jar"><javadoc packagenames="com.google.*"destdir="build/docs"sourcepath="src"docletpath="${jar.file}"bootclasspath="${javahome}/jre/lib/rt.jar"><doclet name="com.google.doclava.Doclava"><param name="-stubs" value="build/stubs" /><param name="-hdf"/> <param name="project.name"/> <param name="Doclava"/><!-- versioning --><param name="-since"/> <param name="doclava/previous.xml"/> <param name="v1" /><param name="-apiversion" value="v2"/><!-- federation --><param name="-federate" /><param name="JDK"/><param name="http://download.oracle.com/javase/6/docs/api/index.html?"/><param name="-federationxml"/><param name="JDK"/><param name="http://doclava.googlecode.com/svn/static/api/openjdk-6.xml"/></doclet></javadoc></target>
</project>
在Maven中使用Doclava
<project>...<build><plugins>...<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-javadoc-plugin</artifactId><version>2.7</version><configuration><docletArtifact><groupId>com.google.doclava</groupId><artifactId>doclava</artifactId><version>1.0.3</version></docletArtifact><doclet>com.google.doclava.Doclava</doclet><!--| bootclasspath required by Sun's JVM--><bootclasspath>${sun.boot.class.path}</bootclasspath><additionalparam>-quiet-federate JDK http://download.oracle.com/javase/6/docs/api/index.html?-federationxml JDK http://doclava.googlecode.com/svn/static/api/openjdk-6.xml-hdf project.name "${project.name}"-d ${project.build.directory}/apidocs</additionalparam><useStandardDocletOptions>false</useStandardDocletOptions><!--| Apple's JVM sometimes requires more memory--><additionalJOption>-J-Xmx1024m</additionalJOption></configuration></plugin></plugins></build>
</project>
改进的标签
Doclava支持一些额外的标签,例如@undeprecate(非常不言自明),@ hide(从文档中删除),@ include $ filePath(包括文件中的文本),@ sample(包括文件中的示例)和一些其他标签。 。 请在此处查看完整列表。
客制化
并且,如果您对旧的Javadoc外观感到厌倦,可以自定义Doclava的输出。 有关更多信息,请单击此处 。
参考: Doclava:来自我们的JCG合作伙伴Felipe Oliveira的 Google自定义Javadoc Doclet 。
相关文章:
- 具有Spring和Maven教程的JAX–WS
- GWT EJB3 Maven JBoss 5.1集成教程
- Tomcat 7上具有RESTeasy JAX-RS的RESTful Web服务– Eclipse和Maven项目
- 正确记录应用程序的10个技巧
- 每个程序员都应该知道的事情
翻译自: https://www.javacodegeeks.com/2011/03/doclava-custom-javadoc-doclet-from.html
javadoc定义异常
javadoc定义异常_Doclava:来自Google的自定义Javadoc Doclet相关推荐
- Doclava:来自Google的自定义Javadoc Doclet
Doclava是Google的自定义Javadoc Doclet,由Google Guice使用(请参阅稍冷的 Javadocs ). Doclava使用JSilver作为其模板引擎,这是Clears ...
- 来自 Google 的高可用架构理念与实践
转自: https://mp.weixin.qq.com/s?__biz=MzAwMDU1MTE1OQ==&mid=402738153&idx=1&sn=af5e76aad2 ...
- 来自 Google 的 R 语言编码风格指南
来自 Google 的 R 语言编码风格指南 R 语言是一门主要用于统计计算和绘图的高级编程语言. 这份 R 语言编码风格指南旨在让我们的 R 代码更容易阅读.分享和检查. 以下规则系与 Google ...
- ASP.NET Core和Web API:用于管理异常和一致响应的自定义包装器
目录 介绍 为什么? 怎么做? VMD.RESTApiResponseWrapper Nuget软件包 安装及使用 ASP.NET Core集成 ASP.NET Web API集成 样本响应输出 定义 ...
- mysql异常处理_MySQL定义异常和异常处理方法
在MySQL中,特定异常需要特定处理.这些异常可以联系到错误,以及子程序中的一般流程控制.定义异常是事先定义程序执行过程中遇到的问题,异常处理定义了在遇到问题时对应当采取的处理方式,并且保证存储过程或 ...
- 【推书】重新定义公司--来自Google运营之道
<重新定义公司>--来自Google运营之道 未来企业的成功之道,是聚集一群聪明的创造人才,营造合适的氛围,充分发挥他们的创造力,快速感知客户的需求,愉快地创造相应的产品和服务.这意味着组 ...
- 来自Google资深工程师的API设计最佳实践
来自Google资深工程师Joshua Bloch的分享:API设计最佳实践 为什么API设计如此重要?API是一个公司最重要的资产. 为什么API的设计对程序员如此重要? API一旦发布,出于兼容性 ...
- C++中的“error:LNK2005 已经在*.obj中定义”异常
C++中的"error:LNK2005 已经在*.obj中定义"异常问题 异常现象如下: C++中的"error:LNK2005 已经在*.obj中定义" ...
- MySQL定义异常和异常处理方法
MySQL定义异常和异常处理方法 参考文章: (1)MySQL定义异常和异常处理方法 (2)https://www.cnblogs.com/yizitrd/p/5445071.html 备忘一下.
最新文章
- 机器学习中的L1与L2正则化图解!
- SQL-Hive中的Select From解析
- 在线作图|2分钟在线绘制RDA图
- spring22:Aspectj实现环绕通知@Around
- Github上删除仓库、项目方法演示
- 用命令行连接到远程计算机
- ios14的蓝牙弹窗_iOS14来了,总结一下给你带来了哪些最实用的功能
- HALCON常用算子(HALCON13.0)
- Python【第一篇】python安装、pip基本用法、变量、输入输出、流程控制、循环
- 扫盲——敏捷开发 Agile development 之 Scrum开发
- 多个表结果的并列显示
- 计算机课程设计大全,单片机课程设计题目大全计算机软件及应用IT计算机专业资料-单片(10页)-原创力文档...
- svn版本管理软件——创建svn私人仓库
- 【python 作日期的折线图和柱状图组合图】
- 计算机内如何关闭wps云盘,WPS轻松去掉WPS网盘,你可以吗?
- SpringBoot 实现AOP的简单测试demo
- 7-2 不变初心数 (15 分)
- 【表格合并单元格】vue-elementul表格动态合并实现方法,合并行,合并列方法【详细讲解,看完就理解】
- 华东师范大学计算机坏老师,华东师范大学:2020各专业录取分数线!毕业当老师的都是铁饭碗...
- π型滤波器 计算_T型π型滤波器计算软件
热门文章
- 相比学习好的学生,老师最喜欢努力认真学习的学生
- Mysql对字符串去掉前后空格(trim)或者指定字符
- JS对象的属性名规则
- 2016蓝桥杯省赛---java---B---7(剪邮票)
- (转)springboot:添加JSP支持
- springboot接收浏览器发送delete请求( method not allowed 405解决方法)
- 网络——连接到server
- java锁_Java锁
- selenium并行_如何在不同的浏览器中设置Selenium网格以并行执行
- azure 部署java_jClarity:在Azure上升级到Java