原文地址:https://www.cnblogs.com/miys/p/4bf714ce33068dcf9ac6526309c9b5e6.html
單行注釋:// 注釋內容
多行注釋:/*... 注釋內容....*/
文本注釋:/**.. 注釋內容....*/
這種注釋可以用來自動地生成文檔。在JDK中有個javadoc的工具,可以由源文件生成一個HTML文檔。使用這種方式注釋源文件的內容,顯得很專業,並且可以隨着源文件的保存而保存起來。
也就是說,當修改源文件時,也可能對這個源代碼的需求等一些注釋性的文字進行修改,那么,這時候可以將源代碼和文檔一同保存,而不用再另外創建一個文檔。
·@author:作者。
·@version:版本。
·@docroot:表示產生文檔的根路徑。
·@deprecated:不推薦使用的方法。
·@param:方法的參數類型。
·@return:方法的返回類型。
·@see:用於指定參考的內容。
·@exception:拋出的異常。
·@throws:拋出的異常,和exception同義
文檔注釋位置
(1)類注釋。類注釋用於說明整個類的功能、特性等,它應該放在所有的“import”語句之后,在class定義之前。
這個規則也適用於接口(interface)注釋。
這個規則也適用於接口(interface)注釋。
(2)方法注釋。方法注釋用來說明方法的定義,比如,方法的參數、返回值及說明方法的作用等。方法注釋應該放在它所描述的方法定義前面。
(3)屬性注釋。默認情況下,javadoc只對公有(public)屬性和受保護屬性(protected)產生文檔——通常是靜態常量。
(4)包注釋。類、方法、屬性的注釋都直接放到Java的源文件中,而對於包的注釋,無法放到Java文件中去,只能通過在包對應的目錄中添加一個package.html的文件來達到這個目的。當生成HTML文件時,package.html文件的<BODY>和</BODY>部分的內容將會被提取出來當做包的說明。關於包注釋,后面還會有更進一步的解釋。
(5)概要注釋。除了包注釋外,還有一種類型的文檔無法從Java源文件中提取,就是對所有類文件提供概要說明的文件。同樣的,也可以為這類注釋單獨新建一個HTML文件,這個文件的名字為“overview.html”,它的<BODY>和</BODY>標記之間的內容都會被提取。