1. 程式人生 > 其它 >016_JAVA基礎語法_文件標記

016_JAVA基礎語法_文件標記

文件標記用於包/類/方法javadoc註釋的第三段。

常見標籤

  1. @author

    • 用於指明作者,可附加郵箱或超連結

    • 有多少個作者就要用多少個該標籤

    • 有時留的是組織名或郵箱

    • 不知道作者是誰時,就寫 @author unascribed

  2. @version 用於指明當前版本號

  3. @since

    • 用於指明最早出現在哪個版本

    • 也可填版本號或日期

    • 也可填可執行的JDK版本

  4. @param

    • 說明方法的引數

    • 先接引數名,再接引數描述,有幾個引數就用幾個該標籤

  5. @code

    • 將一些關鍵字或程式碼解析成程式碼樣式(類似英文論文中對變數使用斜體)

    • 以下必須使用該標籤:Java keywords、package names、class names、method names、interface names、filed names、argument names、code examps。

  6. @return

    • 用於說明return的內容

    • 方法有返回值時必須包括該標籤

  7. @throws、@exception

    • 描述何時丟擲異常

    • @throws、@exception是一模一樣的

所有圖片來源:https://www.cnblogs.com/linj7/p/14339381.html