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

1.背景

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

android源码出现的@字符意义总结_第1张图片

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

2.总结篇

(1)最讨厌的@字符

[java]   view plain copy 在CODE上查看代码片
<EMBED id=ZeroClipboardMovie_1 height=18 name=ZeroClipboardMovie_1 type=application/x-shockwave-flash align=middle pluginspage=http://www.macromedia.com/go/getflashplayer width=18 src=http://static.blog.csdn.net/scripts/ZeroClipboard/ZeroClipboard.swf wmode="transparent" flashvars="id=1&width=18&height=18" allowfullscreen="false" allowscriptaccess="always" bgcolor="#ffffff" quality="best" menu="false" loop="false">
  1. <span style="font-size:18px;">@hide </span>  

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


(2)@link

[java]   view plain copy 在CODE上查看代码片
<EMBED id=ZeroClipboardMovie_2 height=18 name=ZeroClipboardMovie_2 type=application/x-shockwave-flash align=middle pluginspage=http://www.macromedia.com/go/getflashplayer width=18 src=http://static.blog.csdn.net/scripts/ZeroClipboard/ZeroClipboard.swf wmode="transparent" flashvars="id=2&width=18&height=18" allowfullscreen="false" allowscriptaccess="always" bgcolor="#ffffff" quality="best" menu="false" loop="false">
  1. <span style="font-size:18px;">@link </span>  

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


(3)@param

[java]   view plain copy 在CODE上查看代码片
<EMBED id=ZeroClipboardMovie_3 height=18 name=ZeroClipboardMovie_3 type=application/x-shockwave-flash align=middle pluginspage=http://www.macromedia.com/go/getflashplayer width=18 src=http://static.blog.csdn.net/scripts/ZeroClipboard/ZeroClipboard.swf wmode="transparent" flashvars="id=3&width=18&height=18" allowfullscreen="false" allowscriptaccess="always" bgcolor="#ffffff" quality="best" menu="false" loop="false">
  1. <span style="font-size:18px;">@param</span>  


        @param出现的频率最高,它也是javadoc也就是文本记录的字符之一。主要是用来注释以下方法中用到的参数的功能。 

[java]   view plain copy 在CODE上查看代码片
<EMBED id=ZeroClipboardMovie_4 height=18 name=ZeroClipboardMovie_4 type=application/x-shockwave-flash align=middle pluginspage=http://www.macromedia.com/go/getflashplayer width=18 src=http://static.blog.csdn.net/scripts/ZeroClipboard/ZeroClipboard.swf wmode="transparent" flashvars="id=4&width=18&height=18" allowfullscreen="false" allowscriptaccess="always" bgcolor="#ffffff" quality="best" menu="false" loop="false">
  1. <span style="font-size:18px;">/** 
  2. *@param context 
  3. *@param attrs 
  4. */  
  5. Public DotView(Context context, Attribute attrs) {  
  6.      super(context, attrs);  
  7.      setFocusAbleInTouch(true);  
  8. }</span>  


(4)@see

[java]   view plain copy 在CODE上查看代码片
<EMBED id=ZeroClipboardMovie_5 height=18 name=ZeroClipboardMovie_5 type=application/x-shockwave-flash align=middle pluginspage=http://www.macromedia.com/go/getflashplayer width=18 src=http://static.blog.csdn.net/scripts/ZeroClipboard/ZeroClipboard.swf wmode="transparent" flashvars="id=5&width=18&height=18" allowfullscreen="false" allowscriptaccess="always" bgcolor="#ffffff" quality="best" menu="false" loop="false">
  1. <span style="font-size:18px;">@see </span>  

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

[java]   view plain copy 在CODE上查看代码片
<EMBED id=ZeroClipboardMovie_6 height=18 name=ZeroClipboardMovie_6 type=application/x-shockwave-flash align=middle pluginspage=http://www.macromedia.com/go/getflashplayer width=18 src=http://static.blog.csdn.net/scripts/ZeroClipboard/ZeroClipboard.swf wmode="transparent" flashvars="id=6&width=18&height=18" allowfullscreen="false" allowscriptaccess="always" bgcolor="#ffffff" quality="best" menu="false" loop="false">
  1. <span style="font-size:18px;">public abstract class MyBase {  
  2.   protected abstract void myFunc();  
  3. }  
  4.   
  5. cla

你可能感兴趣的:(android源码出现的@字符意义总结)