Android修炼系列（八）

最新推荐文章于 2024-05-01 10:18:50 发布

考研专业组

最新推荐文章于 2024-05-01 10:18:50 发布

阅读量1.8k

点赞数

分类专栏： Android 文章标签：经验分享面试 android

本文链接：https://blog.csdn.net/m0_69439527/article/details/124227892

版权

Android 专栏收录该内容

40 篇文章 4 订阅

订阅专栏

@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类似，见下：在这里插入图片描述 ** Android开源项目《ali1024.coding.net/public/P7/Android/git》 @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 《Android学习笔记总结+最新移动架构视频+大厂安卓面试真题+项目实战源码讲义》开源 {
/*
第一句话是这个方法的简短摘要。
@params capacity 参数的描述
@return 返回值的描述
@since 2.1
*/
public int test2(int capacity) {
return capacity;
}
}