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.cnhttp://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>