chinaweal
/
public
2
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

调整规范倡议的图片引用

This commit is contained in:
黎润豪 2023-05-17 14:11:05 +08:00
parent 548a073d0b
commit 86fdbccfee
5 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
img/JavaDoc1.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 72 KiB

BIN
img/JavaDoc2.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 47 KiB

BIN
img/JavaDoc3.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

BIN
img/JavaDoc4.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 31 KiB

10
技术规范/Java文档注释规范倡议.md
View File

@ -10,7 +10,7 @@
我们使用IDEA编写代码时，调用到一个写了文档注释的方法。我们可以通过`Ctrl+Q`打开对应的文档注释。从而避免在调用方法时，需要打开该方法的代码页，导致两页代码翻来翻去导致思路打乱的情况。如图：
![JavaDoc](https://cloud.qiniu.lroyia.top/blog/img/JavaDoc1.jpg)
![JavaDoc](../img/JavaDoc1.jpg)
### 2、JavaDoc可以识别文档注释生成Java类文档
@ -22,12 +22,12 @@
在写好方法声明后，在方法头输入“/**”后按回车，即可自动生成对应的文档模版，输入对应的内容即可。
正例：
![JavaDoc1](https://cloud.qiniu.lroyia.top/blog/img/JavaDoc2.jpg)
![JavaDoc](https://cloud.qiniu.lroyia.top/blog/img/JavaDoc1.jpg)
![JavaDoc1](../img/JavaDoc2.jpg)
![JavaDoc](../img/JavaDoc1.jpg)
反例：
![JavaDoc3](https://cloud.qiniu.lroyia.top/blog/img/JavaDoc3.jpg)
![JavaDoc3](../img/JavaDoc3.jpg)
反例不可被JavaDoc识别
![JavaDoc4](https://cloud.qiniu.lroyia.top/blog/img/JavaDoc4.jpg)
![JavaDoc4](../img/JavaDoc4.jpg)
## 文档注释基本格式以及常用注解详解