MyEclipse生成Javadoc帮助文档

转载自   MyEclipse生成Javadoc帮助文档 

Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形式程序的开发文档了。

 

Javadoc输出的是一些静态网页文档,经过WEB浏览器来查看它。
Javadoc的语言规则:
所有Javadoc都只能源于结束。应用javadoc有二种方法:

一种是嵌入静态网页;

Javadoc将静态网页源代码嵌入到所生成的静态网页文档中。那样能充分利用静态网页的功能。比如:

  1.   

另一种是应用文档标签

Sample:

import java.util.*;   public class JavaDocTest {   public static void main(String[] args){   System.out.print("HelloWorld!");       
}   
}  


Javadoc只能为public或者protected成员停止文档注释。private和包内访问的成员的注释会被忽略掉。那样做是有道理的,由于只有public和protected成员才能在文档之外被应用,这也体现了封装性的优点。

一、利用Myeclipse都可轻松制作javadoc

利用Myeclipse生产javadoc文档的步骤如下:

1.选择File->Export->javadoc,下一步。

2.Javadoc comand选择JDK的bin目录下的javadoc.exe。选择要生成的源代码和javadoc保存的目的路径,下一步。

3.Document title输入标题,下一步。

4.Extra Javadoc options输入

-windowtitle 'Type B Monitor'[浏览器显示标题]

-bottom <center>Travelsky</center>[底部显示文本],


如果出现编码错误,则填写以下这句

比如项目采用的是UTF8的编码就填:

-encoding UTF-8 -charset UTF-8

 

二、利用3个插件都可轻松制作javadoc

JDocEditor,JAutoDoc,Java2Html。三个小工具,轻松制作JavaDoc.一个是可见即所得的JavaDoc编辑工具,一个是自动建立代码注释的工具,一个是把代码转换成Html格式的工具。
JDocEditor:
http://www.certiv.net/download/downloads.html#jdoceditor
一个所见即所得的Java Doc 编辑器。不用再费神地在代码中调整注释的html标记了,可以自由地编出高质量的带丰富格式的Java Doc 。

JAutoDoc
http://jautodoc.sourceforge.net/index.html#download
自动建立Java Doc 文档。功能十分强大,三个命令实现在所有源代码中加入完整的Java Doc注释。一个命令是加入Package的说明文档,在Package中加入package.html,对package进行说明。
第二个命令是代码文件的头部注释。一个命令就可以自动地在项目的所有代码文件中加入头部注释,或者替换原来的注释。
第三个命令为类、方法、属性加入注释说明。可以根据模式匹配,自动地根据方法的名称,建立更为具有可读性的注释文本。

Java2Html

http://www.java2html.de/eclipse.html
准确地说它不是用来直接建立JavaDoc 的,但是可以用来建立其他文档。它的功能是,把Eclipse中的语法色彩格式转换成为Html,让粘贴到网页上,或者其他文档中的代码带有清晰的语法格式。


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/328605.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Redis集群~StackExchange.redis连接Sentinel服务器并订阅相关事件

对于redis-sentinel我在之前的文章中Redis集群~StackExchange.redis连接Twemproxy代理服务器 已经说过&#xff0c;它是一个仲裁者&#xff0c;当主master挂了后&#xff0c;它将在所有slave服务器中进行选举&#xff0c;选举的原则当然可以看它的官方文章&#xff0c;这与我们…

新闻发布项目——接口类(BaseDao)

package bdqn.newsMange.Dao; /*** 公共类* author Administrator**/ import java.sql.*; import java.util.List; public class BaseDao {Connection connnull;PreparedStatement psnull;ResultSet rsnull;public Connection getConnection() throws ClassNotFoundException, …

docker容器的标准使用过程_phpStorm中使用xdebug工具调试docker容器中的程序

最近使用了docker容器来构建项目&#xff0c;这种方式虽然极大的加快了构建的项目速度&#xff0c;但是也会对之前的本地开发带来一些挑战&#xff0c;比如今天讲到的调试程序&#xff0c;大家对于xdebug一定不会陌生&#xff0c;但是如果php-fpm放到了容器里面&#xff0c;又该…

Meaven的pom文件配置

archtype自动生成的 直接复制讲解一下好了 https://search.maven.org/ maven中央仓库 <project xmlns"http://maven.apache.org/POM/4.0.0" xmlns:xsi"http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation"http://maven.apache.or…

Google 的开源方法论

没有开源&#xff0c;Google 不会有今天的成功。在本周举行的北美 Linux 大会上&#xff0c;Google 工程师 Merlin 从一个第三方视角概括了 Google 是如何使用和为开源做出贡献。自 2002 年以来&#xff0c;Marc Merlin 一直担任 Google 的工程师&#xff0c;期间做过许多开源项…

修改Eclipse/MyEclipse项目的默认编码

转载自 修改Eclipse/MyEclipse项目的默认编码最近遇到问题&#xff0c;在myeclipse新建或导入项目后&#xff0c;有些文件中文显示乱码&#xff0c;每次都要在项目property中修改其编码&#xff0c;所以想到一次性解决所有编码问题&#xff0c;让项目新建或导入之后自动是utf…

hashmap存多少条数据_干货 | 面试官想问的HashMap,都在这一篇里面了!

来源公众号&#xff1a;非科班的科班本文思维导图HashMap简介HashMap 是很常用的一种集合框架&#xff0c;其底层实现方式在 JDK 1.7和 JDK 1.8中却有很大区别。HashMap 是用来存储数据的&#xff0c;它底层在JDK 1.7是数组链表实现的&#xff0c;而JDK 1.8是使用数组链表红黑树…

StackExchange.Redis客户端读写主从配置,以及哨兵配置

今天简单分享一下StackExchange.Redis客户端中配置主从分离以及哨兵的配置。 关于哨兵如果有不了解的朋友&#xff0c;可以看我之前的一篇分享&#xff0c;当然主从复制文章也可以找到。http://www.cnblogs.com/tdws/tag/NoSql/ 为什么要有这篇分享呢&#xff0c;是因为我之前也…

Windows7下如何设置MyEclipse2014字体大小

转载自 Windows7下如何设置MyEclipse2014字体大小Java开发工具MyEclipse2014&#xff0c;安装完毕后发现字体过小&#xff0c;并且对眼睛不好&#xff0c;该如何设置这个开发工具里整体字体大小。设置MyEclipse字体大小&#xff0c;具体实现看下面详细描述双击“MyEclipse Pr…

项目的包结构 mybatis三剑客

mybatis三剑客 1.mybatis generator 数据库自动生成pojo对象类 xml 是dao接口的实现 service调用dao mybatis gentenrator generatorConfig.xml 直接复制 讲解一下 datasource.properties 直接复制 讲解一下 修改一下dao的实现mapper createTime 和 updateT…

css img 适配尺寸_CSS容易使人蒙圈的几个经典问题

本文摘自这一年来自己在工作中经历的几个比较好的CSS问题(不一定复杂&#xff0c;但个人觉得都挺值得一说)&#xff0c;同时也准备了2个JS问题一、CSS篇1.1 元素默认蓝色边框input标签元素(如button、text 、areatext)的一些事件(如click、focus等)&#xff0c;在很多浏览器下默…

怎样增强MyEclipse的代码自动提示功能

转载自 怎样增强MyEclipse的代码自动提示功能 MyElipse的默认代码提示功能隐藏了许多细节&#xff0c;需要开发者手动设置&#xff0c;一起来设置吧&#xff0c;让你的myeclpse更强大 一般在Eclipse &#xff0c;MyEclipse代码里面&#xff0c;打个foreach&#xff0c;switch等…

第一篇:Dapper快速学习

我们都知道ORM全称叫做Object Relationship Mapper&#xff0c;也就是可以用object来map我们的db&#xff0c;而且市面上的orm框架有很多&#xff0c;其中有一个框架叫做dapper&#xff0c;而且被称为the king of ORM。 一&#xff1a;为什么选择Dapper 1. 性能优越&#xff1a…

配置spring、SpringMVC,mybatis进行整合

springframwork的官网 spring-projects/spring-mvc-showcase https://github.com/spring-projects/spring-mvc-showcase spring-projects/greenhouse https://github.com/spring-projects/greenhouse spring-projects/spring-boot spring-boot https://github.com/sprin…

对应node版本_安装Node.js教程

小编首先下载Node.js,首先打开浏览器&#xff0c;然后输入https://nodejs.org/en/&#xff0c;进入nodejs官网&#xff0c;然后按照下图中红色箭头指示步骤2&#xff0c;这个是nodejs8.12版本&#xff0c;下面Recommended For Most Users,这个就是推荐大家使用的版本&#xff0…

Asp.net Core 使用MyCat分布式数据库,实现读写分离

简介   MyCat2.0版本很快就发布了&#xff0c;关于MyCat的动态和一些问题&#xff0c;大家可以加一下MyCat的官方QQ群&#xff1a;106088787。我们今天主要介绍一下&#xff0c;在我们的Asp.net Core中如何使用Mycat&#xff0c;这源于一个大神&#xff08;Amamiya Yuuko&…

如何在MyEclipse中显示行数

转载自 如何在MyEclipse中显示行数如何在MyEclipse中显示行数呢&#xff1f;myeclipse在默认情况下不显示行数时&#xff0c;用户可以自己设置显示行数&#xff0c;行数可以帮助我们方便的查看代码。首先&#xff0c;打开windows菜单然后选择preference&#xff0c;进入首选项…

logback日志配置

直接复制讲一下好了 比较简单 logback 可以看到执行的sql了 mybatis执行的sql了 <?xml version"1.0" encoding"UTF-8"?> <configuration scan"true" scanPeriod"60 seconds" debug"false"><!-- 打印日…

旅游系统_数字洛江智慧旅游系统助力提升旅游安全水平

长期以来&#xff0c;景区客流监测工作都是个“老大难”问题。为进一步提升旅游安全监管水平&#xff0c;今年洛江区将该项工作列入民办实事项目&#xff0c;投入96万元&#xff0c;大力推进智慧旅游项目建设。日前&#xff0c;洛江区智慧旅游系统正式上线运行&#xff0c;该智…

如何在 ASP.NET MVC 中集成 AngularJS

介绍 当涉及到计算机软件的开发时&#xff0c;我想运用所有的最新技术。例如&#xff0c;前端使用最新的 JavaScript 技术&#xff0c;服务器端使用最新的基于 REST 的 Web API 服务。另外&#xff0c;还有最新的数据库技术、最新的设计模式和技术。 当选择最新的软件技术时&am…