03.Java注释（包含javadoc生成规范文档要点）

最新推荐文章于 2022-11-26 16:45:29 发布

林博弈

最新推荐文章于 2022-11-26 16:45:29 发布

阅读量153

点赞数

分类专栏： Java基础知识系统梳理文章标签： Java

本文链接：https://blog.csdn.net/li1009584626/article/details/99820687

版权

15 篇文章 0 订阅

订阅专栏

分为单行注释（\\），多行注释（\* 内容 *\）和文档注释（\** 内容 *\）三种类型

在/** */内些文档注释

在/** */内

1.首先是标记（@开头的句子）
2.自由格式文本（写一些概要型句子，会被javadoc抽出来形成概要页）
ps：
1.自由格式文本可以使用HTML修饰符（但是注意不要用<h1>\<hr>等，会与文档格式冲突）
2.若要键入等宽代码，使用{@code}而不是<code></code>
类设计技巧：
- 一定要保证数据私有（保证封装性）
- 一定要对数据初始化，不能依赖默认值
- 不要在类中使用过多的基本类型（用其他类代替多个基本类型的使用，这样更容易理解易于修改维护）
- 不是所有域都需要独立的与访问器或更改器（根据实际情况看是否需要更改或者访问）
- 将职责过多的类进行分解（复杂的分解为简单的，但是也不要过于极端）
- 类名和方法名要能体现他们的职责
- 优先使用不可改变的类（即线程安全的类）

类注释：import之后，类定义之前
方法注释：方法之前
- 常用标记
  - @param：参数条目
  - @return：返回条目
  - @throws：抛出的异常条目
域注释：例如静态常量的说明
包与概述注释：在包目录中添加以各单独文件
- 提供一个package.html文件（抽取内容）
- 提供一个package-info.java文件（抽取/** */里面的文本）（选择导航栏Overview就会显示内容）

1.控制台目录位置首先切换到生成文档的源文件目录
2.运行命令（以生成到docDirectory目录为例）
- 一个包：javadoc -d docDirectory nameOfPackage
- 多个包：javadoc -d docDirectory nameOfPackage1 nameOfPackage2 …
- 默认包：javadoc -d docDirectory *.java