java 文档注释说明

最新推荐文章于 2022-09-08 15:31:13 发布
最新推荐文章于 2022-09-08 15:31:13 发布
阅读量93 收藏
点赞数
分类专栏： javase
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40435621/article/details/84227736
版权
三种注释方式

我们先要了解三种注释方法：

  • // 单行注释
  • /**/ 多行注释
  • /** */文档注释

我们主要写的 是第三种注释

说明书说明
  • @author （提取作者内容）
  • @version （版本内容）
  • @param 参数名称//形式参数的变量名称@return函数运行返回数据的

使用 javadoc -d 文件指定目录 -author -version

了解更多文档注释

「已注销」
关注
专栏目录
Java 文档注释
奋斗的日子最甜美，在科技的海洋里，永无止境。
11-23 347
Java 文档注释 Java 只是三种注释方式。前两种分别是 // 和 /* */，第三种被称作说明注释，它以 /** 开始，以 */结束。 说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。 说明注释，是你更加方面的记录你的程序的信息。 javadoc 标签 javadoc 工具软件识别以下标签：
文档注释的说明
一无是处的博客
12-22 67
文档注释
文档注释
AlexChen的博客
01-17 450
文档注释是功能级注释，只说明三个地方: 类 常量 方法 文档注释可以被java提供的命令javadoc导出成一个文档。 在类上使用文档注释说明当前类的设计意图以及解决的问题。 ...
Java的三种注释，和文档注释的生成文档说明
Mikchy的博客
06-06 3279
一、单行注释 二、多行注释 三、文档注释 编写注释的原因 编写程序时总需要为程序添加一些注释，用以说明某段代码的作用，或者说明某个类的用途、某个方法的功能，以及该方法的参数和返回值的数据类型及意义等。 编写注释的原因及意义如下： 为了更好的阅读自己编写的代码，建议添加这注释。自己写的代码，可能过一段时间回顾的时候，就变得不熟悉。这个时候，注释就起到了很好的帮助作用。 可读性第一，效率...
Java文档注释用法+JavaDoc的使用详解
热门推荐
阿★永
05-06 4万+
Java文档注释+JavaDoc的使用详解 简介 文档注释负责描述类、接口、方法、构造器、成员属性。可以被JDK提供的工具 javadoc 所解析，自动生成一套以网页文件形式体现该程序说明文档的注释。 注意：文档注释必须写在类、接口、方法、构造器、成员字段前面，写在其他位置无效。 JavaDoc 官方说明 How to Write Doc Comments for the Javadoc Tool...
java文档注释
gpu40200的博客
09-08 1767
java个人笔记
【Java】文档注释
chengwei1128的博客
02-14 5458
文章目录1.概念2. 简单使用演示3. Java的文档注释的基本格式4. javadoc的常用标签 1.概念 文档注释：在程序中采用特定的注释格式进行注释，然后通过JDK提供的工具javadoc来解析，生成一套以网页文件形式体现的程序说明文档。一般写在类。 2. 简单使用演示 演示程序DocComment.java： /** * @author 小明 * @version 1.0 */ public class DocComment{ public static void main(S
Java文档注释说明
Silver6wings的专栏
03-18 883
对于Java语言，最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程序的文档化问题。对于程序的文档化，最大的问题莫过于对文档的维护。若文档与代码分离，那么每次改变代码后都要改变文档，这无疑会变成相当麻烦的一件事情。解决的方法看起来似乎很简单：将代码同文档“链接”起来。为达到这个目的，最简单的方法是将所有内容都置于同一个文件。然而，为使一切都整齐划一，还必须使用一种特殊的注
Java文档注释
有用知识
06-12 327
文档注释： 注释内容可以被JDK所提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档，一般写在类 基本格式：①注释格式 /** * 标签1 * 标签2 */ ②生成格式 javadoc-d 文件夹-xx-yy Comment.java // 文件夹要写路径;-xx-yy是javado
Java的文档注释之生成帮助文档的实例
08-28
* Description: 通过Person类说明Java中的文档注释 * Company: *** * @author *** * @version 1.0 */ ``` 在这个例子中，我们为`Person`类提供了详细的描述，包括类的标题、描述、所属公司、作者和版本信息。...
Java注释全解文档.zip
03-02
- 文档注释：`/** 注释内容 */`，用于生成API文档，如Javadoc。 2. **Spring注解** - `@Autowired`：自动装配bean，根据类型或属性名进行匹配。 - `@Component`、`@Service`、`@Repository`、`@Controller`：...
Java：Java 的注释用法
01-13
总结来说，Java 中的注释分为单行、多行和文档注释三种类型，每种都有其特定的使用场景。单行注释用于快速简单的注解，多行注释适合解释复杂的代码段，而文档注释则用于生成对外部可见的 API 文档，提高代码的可读性...
java代码注释规范文档
09-18
- **格式**：`/** 文档注释内容 */` - **应用场景**： - 为类、方法、字段等提供详细说明。 - 自动生成API文档。 **示例**： ```java /** * 这是一个示例类，用于演示Javadoc注释。 * * @author 张三 * @...
java 将字符串中数字进行排序并返回字符串
qq_40435621的博客
11-21 5593
问题描述 比如我有一字符串"10 50 5 20 36"需要对它进行排序 问题分析 我们一看间我们可能马上就想到了Integer.parseInt()方法，但是str中包含了空格，parseInt是无法解析的 那我们只能用split()方法，先将字符串转化为字符数组 在将数组中的数字转化为int 排序 再拼接成字符串 代码 String s = "10 50 5 20 36"; Strin...
Eclipse简单介绍
qq_40435621的博客
11-18 2243
Java开发工具介绍 操作系统自带的记事本软件 高级记事本软件 集成开发环境 IDE (Integrated Development Environment) Eclipse和MyEclipse的区别 Eclipse是一种可扩展的开放源代码的IDE。 Eclipse的特点描述 免费 纯Java语言编写 免安装 扩展性强 c:MyEclipse 在Eclipse基础上追加的功能性插...
DateFormat类和SimpleDateFormat类简介
qq_40435621的博客
11-23 509
介绍 DateFormat 位于text包中，它是一个抽象类，不能被实例化 DateFormat类是SimpleDateFormat类父类 SimpleDateFormat 是一个以与语言环境有关的方式来格式化和解析日期的具体类。它允许进行格式化（日期 -> 文本）、解析（文本 -> 日期）和规范化。 构造方法 Date date = new Date(); simpleDateFor...
Java的Arrays类介绍
qq_40435621的博客
11-20 322
Arrays 此类包含用来操作数组（比如排序和搜索）的各种方法。此类还包含一个允许将数组作为列表来查看的静态工厂。 多种方法 都是 static 多个字符串转list List<String> strList = Arrays.asList("abc","def","cde"); //asList源码 public static &
java文档注释缩进
最新发布
03-06
在编写Java文档注释时，通常会使用一定的缩进规范来提高可读性和可维护性。 一般来说，Java文档注释的缩进规范如下： 1. 对于每个注释块，使用一个星号（*）作为注释的起始符号，并且每行注释都以一个星号开头。 2....
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值