Java文档注释【自制API】
来源:互联网 发布:淘宝详情页模板源代码 编辑:程序博客网 时间:2024/05/18 00:00
工具类的文档注释
工具类:一般都定义成静态的,只提供工具方法,没有特定数据,不需要构建对象。
为了保证不让其他成员创建对象,将无参的构造函数设置为私有化即可。
源文件:
@author 作者
@version 版本
@param 参数
@return 返回
生成html中的文档化:
注意1:
在每个方法前面加上一个/** * / 文档注释 但是 private 的方法 无法显示到文档
注意2:
如果想进行文档化
类名必须是public的 而且类名与文件名必须一致
D:\javacode\myeclipse\毕向东Java学习视频练习\src\day08>javadoc -d my -author -ve
rsion ArrayTool.java
含义:
javadoc -d ./mydoc -author -version ArrayTool.java
javadoc:dos命令 文档化
-d :后加输出文件的输出目录
. :当前目录
mydoc : 当前文件夹创建mydoc并且输出到该文件夹
-author & -version :文档化中所包含的内容有作者和版本
ArrayTool.java 文档化的目标文件
执行后:生成文件
Cd my
点击index.html
生成javadoc的文件
可以对自己定义的方法进行功能查看
0 0
- Java文档注释【自制API】
- Java注释详解-Java文档注释生成Java API文档
- Java注释详解-Java文档注释生成Java API文档
- Java基础--->02.单行注释、多行注释,文档注释和API文档。
- Java注释及文档注释
- Java菜鸟学习笔记--配置篇(三):Java API 文档下载与文档注释的使用
- JAVA 文档注释--JAVADOC文档
- JAVA项目文档注释规范&&生成自己项目的API文档
- JAVA 文档注释
- java文档注释
- java文档注释
- Java文档注释说明
- java注释文档
- Java文档注释方法
- Java 文档注释
- java文档注释
- Java文档注释摘要
- java注释文档
- 幻灯片播放效果
- 微信公告号实现原理简单介绍;
- 面试金典系列2--原串翻转
- 树莓派之 Dancing Leds
- 基于websocket的扫码登录
- Java文档注释【自制API】
- 【南理oj】55 - 懒省事的小明(优先队列,贪心)
- 解惑java下dao,model,service,impl,util包名含义
- EC2上源安装vnstat
- 图解y420
- 面试金典系列3--确定两串乱序同构
- linux sort,uniq,cut,wc命令详解
- 计算机组成原理.part0
- java日期格式大全 format SimpleDateFormat