diff --git a/img/JavaDoc1.jpg b/img/JavaDoc1.jpg new file mode 100644 index 0000000..7ec0583 Binary files /dev/null and b/img/JavaDoc1.jpg differ diff --git a/img/JavaDoc2.jpg b/img/JavaDoc2.jpg new file mode 100644 index 0000000..e135223 Binary files /dev/null and b/img/JavaDoc2.jpg differ diff --git a/img/JavaDoc3.jpg b/img/JavaDoc3.jpg new file mode 100644 index 0000000..75fef41 Binary files /dev/null and b/img/JavaDoc3.jpg differ diff --git a/img/JavaDoc4.jpg b/img/JavaDoc4.jpg new file mode 100644 index 0000000..2557cbd Binary files /dev/null and b/img/JavaDoc4.jpg differ diff --git a/技术规范/Java文档注释规范倡议.md b/技术规范/Java文档注释规范倡议.md index c05d43e..abe8e40 100644 --- a/技术规范/Java文档注释规范倡议.md +++ b/技术规范/Java文档注释规范倡议.md @@ -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) ## 文档注释基本格式以及常用注解详解