Android修炼系列（八），你真的会写注释吗？

2401_84123265

于 2024-04-22 21:01:02 发布

阅读量299

点赞数 5

分类专栏：程序员文章标签： android

本文链接：https://blog.csdn.net/2401_84123265/article/details/138092127

版权

程序员专栏收录该内容

406 篇文章 0 订阅

订阅专栏

这是列表1
这是列表2...
同样回车后与标签对齐即可

*/
public void test(){}

@param 是用来描述方法的输入参数。注意在方法描述和tag 之间需要插入空白注释行。不需要每个参数param的描述都对齐，但要保证同个param的多行描述对齐。param 的描述不需要在句尾加标点。

/**

第一句话是这个方法的简短摘要。
如果这个描述太长，记得换行。
@param builderTest 添加参数的描述，如果描述很长，

               需要回车，这里需要对齐

@param isTest 添加参数描述，不需要刻意与其他param
```
          参数对齐
```

*/
public void test(String builderTest, boolean isTest){}

@return 是用来描述方法的返回值。要写在@param tag之后，与其他tag 之间不需要换行。@throws 是对方法可能会抛出的异常来进行说明的，通常格式为：异常类名+异常在方法中出现的原因。见下：

/**

第一句话是这个方法的简短摘要。
@param capacity 添加参数描述，不需要刻意与其他param
```
            参数对齐
```
@return 描述返回值的含义，可以多行，不需要句号结尾
@throws IllegalArgumentException 如果初始容量为负
```
    <ul>
```

    <li>这是抛出异常的条件1（非必须），注意<li>格式

```
    </ul>
```
@throws 注意如果方法还存在其他异常，可并列多个
*/
public int test(int capacity){
if (capacity < 0)
throw new IllegalArgumentException(“Illegal initial capacity”);
return capacity;
}

@deprecated 用于指出一些旧特性已由改进的新特性所取代，建议用户不要再使用旧特性。常与@link 配合，当然@link的使用位置没有任何限制，当我们的描述需要涉及到其他类或方法时，我们就可以使用@link啦，javadoc会帮我们生成超链接：

/**

第一句话是这个方法的简短摘要。
如果这个描述太长，记得换行。
@deprecated 从2.0版本起不推荐使用，替换为{@link #Test2()}
@param isTest 添加参数描述，不需要刻意与其他param
```
          参数对齐
```

*/
public void test(boolean isTest){}

@link 常见形式见下: 在这里插入图片描述

@code 用来标记一小段等宽字体，也可以用来标记某个类或方法，但不会生成超链接。常与@link配合，首次通过@link生成超链接，之后通过@code 呈现等宽字体。

/**

第一句话是这个方法的简短摘要。
我们可以关联{@link Test}类，随后通过{@code Test}类怎样怎样
也可以标记一个方法{@code request()}
@param isTest 添加参数描述，不需要刻意与其他param
```
          参数对齐
```

*/
public void test(boolean isTest){}

@see 用来引用其它类的文档，相当于超链接，javadoc会在其生成的HTML文件中，将@see标签链到其他的文档上：

/**

第一句话是这个方法的简短摘要。
@param capacity 添加参数描述，不需要刻意与其他param
```
            参数对齐
```
@return 描述返回值的含义，可以多行，不需要句号结尾
@throws IllegalArgumentException 如果初始容量为负
@see com.te.Test2
@see #test(int)
*/
public int test(int capacity){
if (capacity < 0)
throw new IllegalArgumentException(“Illegal initial capacity”);
return capacity;
}

@see形式与@link类似，见下：在这里插入图片描述 @since 用来指定方法或类最早使用的版本。在标记类时，常与@version和@author配合，一个用来指定当前版本和版本的说明信息，一个用来指定编写类的作者和联系信息等。我们也可以通过< pre>来添加一段代码示例。见下：

/**

第一句话是这个类的简短摘要。
```
Test<Test2> t = new Test<>();
```
同样可以多个段落。
@param 注意当类使用泛型时，我们需要使用params说明。这时格式需要插入空白行
@author mjzuo 123@qq.com
@see com.te.Test2
@version 2.1
@since 2.0
/
public class Test {
/*
第一句话是这个方法的简短摘要。
@params capacity 参数的描述
@return 返回值的描述
@since 2.1
*/
public int test2(int capacity) {
return capacity;
}
}
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。