【JavaSE】规范——文档注释

简介: 1 文档注释😎注释内容可以被JDK提供的工具javadoc所解析,生成一套以网页文件形式体现的该程序的说明文档,一般写在类。

1 文档注释

😎注释内容可以被JDK提供的工具javadoc所解析,生成一套以网页文件形式体现的该程序的说明文档,一般写在类。


2 基本格式

/**

*@author xxx

*@version xxx

*/


3 例子

⭐️该类中存有一个方法,gcd,用于求两数的最大公因数。


4 生成文档注释

格式:

javadoc -d 文件夹名 -author -version 文件名.java

例子:

【注意】如果注释中有中文,需要把编码转成GBK形式



在D盘对应的temp文件夹就可以找到生成的文档注释,打开index.html即可


相关文章
|
7月前
|
Java
javaSE基础代码案例
javaSE基础代码案例
|
3月前
|
Java API 开发者
Java 注释规范
Java中的注释规范包括单行注释(`//`)、多行注释(`/* ... */`)和文档注释(`/** ... */`)。单行注释适用于简短说明,多行注释用于较长描述,文档注释则专为自动生成API文档设计。注释应清晰明了、及时更新,避免冗余,并详细说明参数和返回值。遵循这些规范有助于提高代码的可读性和可维护性。
204 5
|
6月前
|
Java
Java代码规范--排版,命名
Java代码规范--排版,命名
91 0
|
7月前
|
Java 程序员
命名之美:探索Java的标识符与命名规范
命名之美:探索Java的标识符与命名规范
|
存储 Java 编译器
【JavaSE语法】类和对象(一)
【JavaSE语法】类和对象(一)
47 0
|
Java 编译器
教你精通JavaSE语法第五章、方法的使用
JavaSE的方法的使用详细介绍,适用于初学者和有一定基础的学生对方法的概念复习和细节上的掌握
56 0
|
存储 设计模式 缓存
Java代码命名规范是真优雅呀!代码如诗
Java代码命名规范是真优雅呀!代码如诗
628 0
|
Java 编译器 Spring
|
Java 程序员 数据安全/隐私保护
JAVA基础——命名规范、代码注释、抒写格式、关键字
JAVA基础——命名规范、代码注释、抒写格式、关键字
245 0
JAVA基础——命名规范、代码注释、抒写格式、关键字
|
Java API
开发这么久了,你会使用文档注释吗?Java 文档注释详解
开发这么久了,你会使用文档注释吗?Java 文档注释详解
356 0
开发这么久了,你会使用文档注释吗?Java 文档注释详解