1.背景
在android源码中我们能看到各种以@开头的字符,他们大多出现在注释中,如下图所示
但是可不要小看了它们地作用,昨天当我编译源码的时候,就在一个“@link”处报错了,下面就总结下常用的@字符的意义。
2.总结篇
(1)最讨厌的@字符
<span style="font-size:18px;">@hide</span>
@hide字符一般出现在源码类或者方法的开头注释部分,表示这个方法或者类是在google提供的sdk中隐藏起来的,不能直接调用。要是想使用可以用反射,编译源码等方法。
(2)@link
<span style="font-size:18px;">@link</span>
@link字符是可以单独使用如:@link sth 或者@link sth1#sth2。主要是用来生成javadoc文件使用。当我们去掉这个字符是否会对编译造成影响我还在实验,稍后会贴上结果。
(3)@param
<span style="font-size:18px;">@param</span>
查看本栏目更多精彩内容:http://www.bianceng.cn/OS/extra/
@param出现的频率最高,它也是javadoc也就是文本记录的字符之一。主要是用来注释以下方法中用到的参数的功能。
<span style="font-size:18px;">/** *@param context *@param attrs */ Public DotView(Context context, Attribute attrs) { super(context, attrs); setFocusAbleInTouch(true); }</span>
(4)@see
<span style="font-size:18px;">@see</span>
@see提示用户相关的类或是函数信息。
<span style="font-size:18px;">public abstract class MyBase { protected abstract void myFunc(); } class MyImpl extends MyBase { /** * @see MyBase#myFunc() */ @Override protected void myFunc() { .. } }</span>