android源碼出現的@字符意義總結

(轉載請註明出處:https://blog.csdn.net/buptgshengod)

1.背景

在android源碼中我們能看到各種以@開頭的字符,他們大多出現在註釋中,如下圖所示

但是可不要小看瞭它們地作用,昨天當我編譯源碼的時候,就在一個“@link”處報錯瞭,下面就總結下常用的@字符的意義。vcD4KPGgxPjIu19y94caqPC9oMT4KPHA+o6gxo6nX7szW0eG1xEDX1rf7PC9wPgo8cD48L3A+CjxwcmUgY2xhc3M9″brush:java;”>@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() { .. }
}

發佈留言