java類和方法注釋模板(java語言三種注釋的語法格式以及用途)

本文目錄一覽:

java中怎樣用eclipse快捷為方法生成備註:就是格式是/** *@param *@return *@throws /

你好 首先在preferences里設置java-compiler-javadoc 設置或導入模板 在類或方法前用/**+enter鍵就能快捷注釋.

java中如何自動生成注釋

你說的應該是生成javadoc吧?

最簡單方式就是使用命令行, cd到你的項目源代碼目錄下, 輸入如下指令:

javadoc -d docs -subpackages com.yourpackage

其中-d docs指定了生成的javadoc在相對目錄docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代碼包.

JAVADOC是官方提供的一種生成注釋文檔的工具, 他的用法如下:

用法: javadoc [options] [packagenames] [sourcefiles] [@files]

  -overview file                 從 HTML 文件讀取概覽文檔

  -public                          僅顯示 public 類和成員

  -protected                       顯示 protected/public 類和成員 (默認值)

  -package                         顯示 package/protected/public 類和成員

  -private                         顯示所有類和成員

  -help                            顯示命令行選項並退出

  -doclet class                  通過替代 doclet 生成輸出

  -docletpath path               指定查找 doclet 類文件的位置

  -sourcepath pathlist           指定查找源文件的位置

  -classpath pathlist            指定查找用戶類文件的位置

  -cp pathlist                   指定查找用戶類文件的位置

  -exclude pkglist               指定要排除的程序包列表

  -subpackages subpkglist        指定要遞歸載入的子程序包

  -breakiterator                   計算帶有 BreakIterator 的第一個語句

  -bootclasspath pathlist        覆蓋由引導類載入器所載入的

                                   類文件的位置

  -source release                提供與指定發行版的源兼容性

  -extdirs dirlist               覆蓋所安裝擴展的位置

  -verbose                         輸出有關 Javadoc 正在執行的操作的信息

  -locale name                   要使用的區域設置, 例如 en_US 或 en_US_WIN

  -encoding name                 源文件編碼名稱

  -quiet                           不顯示狀態消息

  -Jflag                         直接將 flag 傳遞到運行時系統

  -X                               輸出非標準選項的提要

通過標準 doclet 提供:

  -d directory                   輸出文件的目標目錄

  -use                             創建類和程序包用法頁面

  -version                         包含 @version 段

  -author                          包含 @author 段

  -docfilessubdirs                 遞歸複製文檔文件子目錄

  -splitindex                      將索引分為每個字母對應一個文件

  -windowtitle text              文檔的瀏覽器窗口標題

  -doctitle html-code            包含概覽頁面的標題

  -header html-code              包含每個頁面的頁眉文本

  -footer html-code              包含每個頁面的頁腳文本

  -top    html-code              包含每個頁面的頂部文本

  -bottom html-code              包含每個頁面的底部文本

  -link url                      創建指向位於 url 的 javadoc 輸出的鏈接

  -linkoffline url url2        利用位於 url2 的程序包列錶鏈接至位於 url 的文檔

  -excludedocfilessubdir name1:.. 排除具有給定名稱的所有文檔文件子目錄。

  -group name p1:p2..        在概覽頁面中, 將指定的程序包分組

  -nocomment                       不生成說明和標記, 只生成聲明。

  -nodeprecated                    不包含 @deprecated 信息

  -noqualifier name1:name2:… 輸出中不包括指定限定符的列表。

  -nosince                         不包含 @since 信息

  -notimestamp                     不包含隱藏時間戳

  -nodeprecatedlist                不生成已過時的列表

  -notree                          不生成類分層結構

  -noindex                         不生成索引

  -nohelp                          不生成幫助鏈接

  -nonavbar                        不生成導航欄

  -serialwarn                      生成有關 @serial 標記的警告

  -tag name:locations:header 指定單個參數定製標記

  -taglet                          要註冊的 Taglet 的全限定名稱

  -tagletpath                      Taglet 的路徑

  -charset charset               用於跨平台查看生成的文檔的字符集。

  -helpfile file                 包含幫助鏈接所鏈接到的文件

  -linksource                      以 HTML 格式生成源文件

  -sourcetab tab length          指定源中每個製表符佔據的空格數

  -keywords                        使程序包, 類和成員信息附帶 HTML 元標記

  -stylesheetfile path           用於更改生成文檔的樣式的文件

  -docencoding name              指定輸出的字元編碼

java中怎樣實現註解的構造函數

你是要在構造方法上加註解還是,在自定義註解類中實現構造方法?

1、構造方法上加註解和普通方法加註解是一樣的在構造方法定義前加 @註解類型就像行了。

public class Car {

    

    @Deprecated

    public Car() {

    }

    

}

2、java語義規定註解類不能定義構造方法。可以使用default 關鍵字規定默認值,規定了默認值在使用時就可以省略屬性賦值。

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.METHOD)

@Documented

@Inherited

public @interface Auth {

    /**

     * 是否驗證登陸 true=驗證 ,false = 不驗證

     * @return

     */

    public boolean verifyLogin() default true;

    /**

    * 是否驗證URL true=驗證 ,false = 不驗證

    * @return

    */

    public boolean verifyURL() default true;

    

}

原創文章,作者:小藍,如若轉載,請註明出處:https://www.506064.com/zh-tw/n/189972.html

(0)
打賞 微信掃一掃 微信掃一掃 支付寶掃一掃 支付寶掃一掃
小藍的頭像小藍
上一篇 2024-11-29 13:53
下一篇 2024-11-29 13:53

相關推薦

  • Vb運行程序的三種方法

    VB是一種非常實用的編程工具,它可以被用於開發各種不同的應用程序,從簡單的計算器到更複雜的商業軟體。在VB中,有許多不同的方法可以運行程序,包括編譯器、發布程序以及命令行。在本文中…

    編程 2025-04-29
  • Python語法大全解析

    本文旨在全面闡述Python語法,並提供相關代碼示例,幫助讀者更好地理解Python語言。 一、基礎語法 1、Python的注釋方式 # 這是單行注釋 “”” 這是多行注釋,可以注…

    編程 2025-04-29
  • Python程序的三種基本控制結構

    控制結構是編程語言中非常重要的一部分,它們指導著程序如何在不同的情況下執行相應的指令。Python作為一種高級編程語言,也擁有三種基本的控制結構:順序結構、選擇結構和循環結構。 一…

    編程 2025-04-29
  • Python中複數的語法

    本文將從多個方面對Python中複數的語法進行詳細的闡述。Python中的複數是指具有實部和虛部的數,其中實部和虛部都是浮點數。它們可以用「實數+虛數j」的形式表示。例如,3 + …

    編程 2025-04-29
  • parent.$.dialog是什麼技術的語法

    parent.$.dialog是一種基於jQuery插件的彈出式對話框技術,它提供了一個方便快捷的方式來創建各種類型和樣式的彈出式對話框。它是對於在網站開發中常見的彈窗、提示框等交…

    編程 2025-04-28
  • Python三種基本輸入元素

    本文將從多個方面對於Python三種基本輸入元素進行詳細的闡述並給出代碼示例。 一、Python三種基本輸入元素解答 Python三種基本輸入元素包括命令行參數、標準輸入和文件輸入…

    編程 2025-04-28
  • 異或什麼意思及其用途

    異或操作是一種比較常見的位運算操作,也稱為「異或運算」,這個運算符用符號「^」表示。它是指對兩個相應位進行邏輯異或,並返回結果。 我們來看下異或的運算規則: 0 ^ 0 = 0 0…

    編程 2025-04-28
  • 編譯原理語法分析思維導圖

    本文將從以下幾個方面詳細闡述編譯原理語法分析思維導圖: 一、語法分析介紹 1.1 語法分析的定義 語法分析是編譯器中將輸入的字元流轉換成抽象語法樹的一個過程。該過程的目的是確保輸入…

    編程 2025-04-27
  • Python進階語法全面解析

    Python語言作為一種廣泛應用於人工智慧、數據分析、雲計算等多個領域的編程語言,擁有廣泛的社區和強大的生態系統。Python提供了基本語法以及常用函數和模塊,用於解決大量常規編程…

    編程 2025-04-27
  • 詳解Spring創建Bean的三種方式

    一、XML配置方式 1、XML配置文件是Spring中最早被使用的方式,也是最為傳統的方式。它通過在Bean配置文件中對類進行描述以初始化Bean。下面是一個XML配置的樣例: &…

    編程 2025-04-25

發表回復

登錄後才能評論