Java文档注释【自制API】

工具类的文档注释

工具类：一般都定义成静态的，只提供工具方法，没有特定数据，不需要构建对象。

为了保证不让其他成员创建对象，将无参的构造函数设置为私有化即可。

源文件：

@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的文件

可以对自己定义的方法进行功能查看

Java文档注释【自制API】相关推荐

java文档注释生产api没有注释_如何使用javadoc命令生成api文档，文档注释
/** * 计算器工具类 * * @62616964757a686964616fe78988e69d8331333365646332author GaoHuanjie * @version V1.0 ...
java文档注释生产api没有注释_一个神奇的没有springboot注释的api文档生成器---JApiDocs...
入门支持JDK:1.8+ 快速开始第一步:添加依赖 maven: io.github.yedaxia japidocs 1.4.3 gradle: compile 'io.github.yedax ...
Java注释详解-Java文档注释生成Java API文档
Java文档注释是一种功能强大的注释形式,如果在你所编写的程序中规范的添加文档注释,那你就可以生成一份系统正规的API文档.Java文档注释 /**文档注释内容*/,注意区分多行注释/*多行注释*/. ...
Java文档注释用法+JavaDoc的使用详解
Java文档注释+JavaDoc的使用详解简介文档注释负责描述类.接口.方法.构造器.成员属性.可以被JDK提供的工具 javadoc 所解析,自动生成一套以网页文件形式体现该程序说明文档的注释. ...
java文档注释报错,java文档注释主要使用方法
一.java包含哪些注释 1.//用于单行注释. 2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套. 3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句.这 ...
java文档注释编写格式
java 文档注释在sun主页上有java文档注释的编写格式 How to Write Doc Comments for the Javadoc Tool http://java.sun.com/j ...
IDEA JAVA文档注释和方法注释模板
IDEA JAVA文档注释和方法注释模板文档注释 #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${ ...
如何写Java文档注释(Java Doc Comments)
本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的东西本文不讨论如何使用javadoc工具自动生成文档的方法,而是主 ...
java文档注释return_Java-文档注释
Java-文档注释 Java语言支持三种类型的注释- Sr.No. Comment & Description 1 /* text */ The compiler ignores everyt ...

Java文档注释【自制API】

Java文档注释【自制API】相关推荐

最新文章

热门文章