【Android注释技巧】Android函数上面的注释你是怎么写的？（Eclipse中）

最新推荐文章于 2023-02-08 13:33:12 发布

阿曌

最新推荐文章于 2023-02-08 13:33:12 发布

阅读量1.2w

点赞数 11

分类专栏： * 有趣的代码 * 个人小结文章标签： Eclipse 注释 see link Android

本文链接：https://blog.csdn.net/xieyupeng520/article/details/47320631

版权

本文介绍了如何在Eclipse中快速生成和自定义Android函数的文档注释，包括使用Alt + Shift + J快捷键生成注释，解释了注释中的字段如@author, @param, @return的意义，并展示了如何修改注释模板以添加自定义标签，以及如何通过@see和{@link}进行链接和跳转。" 51089626,1276639,大数乘法：分块策略详解与实现,"['大数运算', '算法', '编程']

摘要由CSDN通过智能技术生成

前言：你用过Eclipse快捷键 Alt + Shift + J 么？你看过源码么？如果看过，你注意过源码上面的注释么？你知道为什么看源码注释有些标识的参数可以直接点击跳转么？

先出个题目，定义一个最简单的Person类，三个属性，一个name，一个age，一个性别，一个带所有属性参数的构造函数，你会怎么写？

public class Person {
   
    private String mName;
    private int mAge;
    private int mSex;

    public Person(final String name, final int age, final int sex) {
        super();
        this.mName = name;
        this.mAge = age;
        this.mSex = sex;
    }
}

我相信没有人在做项目时是这么干巴巴地写吧！一点注释都没有！这里例子简单，从属性名就能看出意思，如果换难理解一点的，代码量又增多时，看起来就会很头疼了。

1. 如何快速生成文档注释

其实Eclipse有快速生成文档注释的办法，光标定位到要注释的类、属性或者函数上，然后右键 -> Source -> Generate Element Comment，我更喜欢用快捷键 Alt + Shift + J，就能自动生成注释了！

这里写图片描述

顺带一提一点基础技巧，图中右侧下面的

Generate Constructor using
Fields…
能快速生成带属性参数的构造函数；（我上文说要生成多参数构造函数就可以这么快速生成）
Generate Getters and Setters…
快速生成属性的获取器和设置器；（这个功能学校老师为了让我们多敲点代码没说，在实习的时候才知道有这功能）
Override / Implement Methods…
能够快速选择要重写或者要实现的超类的函数；

然后自动生成注释后的代码变成了这个样子