android源码出现的@字符意义总结

(转载请注明出处:http://blog.csdn.net/buptgshengod

1.背景

       在android源码中我们能看到各种以@开头的字符,他们大多出现在注释中,如下图所示

但是可不要小看了它们地作用,昨天当我编译源码的时候,就在一个“@link”处报错了,下面就总结下常用的@字符的意义。

2.总结篇

(1)最讨厌的@字符

@hide

       @hide字符一般出现在源码类或者方法的开头注释部分,表示这个方法或者类是在google提供的sdk中隐藏起来的,不能直接调用。要是想使用可以用反射,编译源码等方法。


(2)@link

@link
      @link字符是可以单独使用如:@link sth 或者@link sth1#sth2。主要是用来生成javadoc文件使用。当我们去掉这个字符是否会对编译造成影响我还在实验,稍后会贴上结果。


(3)@param

@param

        @param出现的频率最高,它也是javadoc也就是文本记录的字符之一。主要是用来注释以下方法中用到的参数的功能。 
/**
*@param context
*@param attrs
*/
Public DotView(Context context, Attribute attrs) {
     super(context, attrs);
     setFocusAbleInTouch(true);
}


(4)@see

@see
           @see提示用户相关的类或是函数信息。

public abstract class MyBase {
  protected abstract void myFunc();
}

class MyImpl extends MyBase {

  /**
   * @see MyBase#myFunc()
   */
  @Override
  protected void myFunc() { .. }
}


  • 2
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值