Myeclipse文档注释如何提炼(导出)成自己的API帮助文档?

第一步:

        源码注释规范,一定要用/** 两个*这一特殊的注释。注释上可以添加@author等特殊说明,下图是部分 javadoc 标记 信息,可以根据需要选用。

        

   

      第二步:

        确保整个工程的项目都添加了特殊注释后,右键工程,选择export导出。

        

      第三步:

        选择java—>javadoc,然后点击next(下一步)。

        

      第四步:

        这个选项可以选择javadoc命令,要生成api的工程以及API存放的路径。javadoc command会自动选择安装的jdk的bin目录下的javadoc应用程序,如果没有自动选择,点击configure选择。

        

    第五步:

        选择完后点击next(下一步),可选择jar包,编辑标题,样式等,这里选择默认。

         

    第六步:

       点击next(下一步),根据需要填写VM options信息。

        

      第七步:

          最后点击”finish",选择”yes to all“开始生成java API文档信息。

          

        第八步:

          生成后到刚刚保存的目录下,找到index.html打开文档查看信息。

          

          

时间: 2024-12-18 12:54:58

Myeclipse文档注释如何提炼(导出)成自己的API帮助文档?的相关文章

【iOS开发-45】Tom猫案例:动画、imageNamed与imageWithContentOfFile对内存影响、图片文件夹放哪儿以及文档注释

今天tom猫案例效果: (1)最傻最笨的办法: --所有的点击都是按钮,只不过有6个有图标的按钮,有些头部.左右脚.肚子.尾巴那块也是一个按钮,只不过没背景没文字没边框的按钮用户按不到而已. --这里的帧动画核心是UIImageView对象的一个属性animationImages,这个属性里面是以数组形式存放的图片.当然还有个重要的方法startAnimating用来播放前面那个属性里面的图片,就形成动画.再当然一下,还有设置时间和播放次数的属性. 注意点: --我们一般把图片放在Images.

MyEclipse保存文件时 自动格式化代码! 不包括文档注释

设置不格式化 文档注释

javaOO——引用数据类型数组与文档注释

引用数据类型的数组: 1.引用数据类型数组在语法上和基本数据类型是没有区别的 2.引用类型变量可以使用类.接口或数组来声明. 3.数组引用变量是存放在栈内存(stack)中,数组元素是存放在堆内存(heap)中,通过栈内存中的指针指向对应元素在堆内存中的位置来实现访问. 文档注释: [文档注释]是写在类.方法.成员变量的上面的. 文档注释可以用eclipse导出chm格式的帮助文档,拿给其他人用时,方便他人理解.文档注释被调用的方法,当鼠标移到上面时提醒注释内容. 使用文档注释时,需要在开始的 

java笔记------文档注释标记,String相关的API

常用的javadoc标记有以下几种: [email protected] 程序的作者说明 [email protected] 源文件的版本说明 [email protected] 方法的参数说明 [email protected] 不建议的使用方法 [email protected] 方法的返回值的说明信息 [email protected] 参见,用于指定参考内容 [email protected] 抛出的异常类型 [email protected] 抛出的异常 可以出现在类或者接口文档注释中

C# XML 文档注释文件格式

在编写 C# 代码时,只要在注释按照格式加入 XML 文档注释,例如: /// <summary> /// 这里是类的注释. /// </summary> public class MyClass { } 就可以通过设置项目的"属性->生成->输出->XML 文档文件",来为当前项目生成包含所有文档注释的 XML 文件.一般可用于 Visual Studio 的智能提示,或者利用 Sandcastle 等工具生成文档. 下面,我会介绍生成的 X

Java 文档注释

Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息,并输出到HTML文件中. 说明注释,是你更加方面的记录你的程序的信息. javadoc 标签 javadoc工具软件识别以下标签: 标签 描述 示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @deprecated de

静态的应用与文档注释

一.静态的应用一: 比如数组工具类: 每个应用程序中都有共性的功能,可以将这些功能进行抽取,独立封装以便复用 虽然可以通过建立ArrayTool的对象使用这些工具方法对数组进行操作 但是: 1.对象是用于封装数据的,可是ArrayTool对象并没封装特有数据(没有成员变量). 2.操作数组的每一个方法都没有用到ArrayTool对象中的特有数据 这时就考虑,让程序更严谨,是不需要对象的,可以将ArrayTool中的方法都定义成static的,直接用类名调用 将方法都静态后,可以方便于使用,但是该

关于文档注释规范

关于文档注释规范 准备工作: 双击打开文件夹 用editplus或其他编辑器打开 修改配置文件中: 引入配置文件: Step1:将模板配置文件放在myeclipse的安装目录下 Step2:window ---> preference Step3:导入配置文件 使用: Step1: Step2:则会自动生成注释,按上面的要求写注释 关于编码规范 参考<华为编码规范>文档. 附录: <?xml version="1.0" encoding="UTF-8&

利用HttpResponse将DataTable数据导出为Excel/Word/Txt/Html文档

Web项目中,很多时候须要实现将查询的数据集导出为Excel.Word等文档的功能,很多时候不太希望在工程中添加对Office组件相关的DLL的引用,甚至有时候受到Office不同版本的影响,导致在不同的服务器上部署后功能受限,或和其它项目冲突,那么,使用这种简单粗暴的方式,可能会解决部分猿类的烦恼忧愁. public static bool DataTableToExcel(System.Data.DataTable dataTable, string fileName) { if (data