本文目錄一覽:
Java注釋有幾種類型
三種類型:
1、單選注釋:符號是://
2、塊注釋: 符號是: /* */ 可以跨多行
3、javadoc注釋: 符號是: /** */ 可以跨多行, 生成javadoc時,這樣的注釋會被生成標準的javaapi注釋。
簡述JAVA程序中注釋的作用及類型。
對於Java注釋我們主要了解三種:
1, // 注釋一行
2, /* …… */ 注釋若干行
3, /**……*/文檔注釋 /** …… */ 注釋若干行,並寫入 javadoc文檔
java圖標通常這種注釋的多行寫法如下: /** * ……… * ……… */
Java:
Java是一門面向對象編程語言,不僅吸收了C++語言的各種優點,還摒棄了C++里難以理解的多繼承、指針等概念,因此Java語言具有功能強大和簡單易用兩個特徵。Java語言作為靜態面向對象編程語言的代表,極好地實現了面向對象理論,允許程序員以優雅的思維方式進行複雜的編程 。
Java具有簡單性、面向對象、分散式、健壯性、安全性、平台獨立與可移植性、多線程、動態性等特點 。Java可以編寫桌面應用程序、Web應用程序、分散式系統和嵌入式系統應用程序等。
如何在java程序中添加註釋
1、單行(single-line)–短注釋://…… 單獨行注釋:在代碼中單起一行注釋, 注釋前最好有一行空行,並與其後的代碼具有一樣的縮進層級。如果單行無法完成,則應採用塊注釋。 注釋格式:/* 注釋內容 */ 行頭注釋:在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。 注釋格式:// 注釋內容 行章節附註釋:尾端(trailing)–極短的注釋,在代碼行的行尾進行注釋。一般與代碼行後空8(至少4)個格,所有注釋必須對齊。 注釋格式:代碼 + 8(至少4)個空格 + // 注釋內容
2、塊(block)–塊注釋:/*……*/ 注釋若干行,通常用於提供文件、方法、數據結構等的意義與用途的說明,或者演算法的描述。一般位於一個文件或者一個方法的前面,起到引導的作用,也可以根據需要放在合適的位置。這種域注釋不會出現在HTML報告中。注釋格式通常寫成: /* * 注釋內容 */
3、文檔注釋:/**……*/ 注釋若干行,並寫入javadoc文檔。每個文檔注釋都會被置於注釋定界符 /**……*/ …
Java 語言有哪幾種注釋符?
單行注釋:
從「//」開始到行末結束,均視為單行注釋。
多行注釋:
從「/*」開始到「*/」結束,均視為多行注釋。
文檔注釋:
從「/**」開始到「*/」結束,均視為文檔注釋。
文檔注釋與多行注釋的區別:
文檔注釋可以用javadoc命令提取出來,生成類似於jdk文檔的網頁文件,以便於他人了解一個類的功能。
java 中的幾種注釋方式
我看動力節點的java基礎大全301集教中的三種注釋方法:
1、單行注釋 //注釋的內容
2、多行注釋 /*……*/
3、/**……*/,這種方式和第二種方式相似。這種格式是為了便於javadoc程序自動生成文檔。
下面介紹一下Javadoc的標記:
特別聲明:
(1)javadoc針對public類生成注釋文檔
(2)javadoc只能在public、protected修飾的方法或者屬性之上
(3)javadoc注釋的格式化:前導*號和HTML標籤
(4)javadoc注釋要僅靠在類、屬性、方法之前
下面主要舉例說明第三種注釋的應用:
(1)首先編寫.java文件
(2)在命令行中執行以下dos命令:
javadoc *.java //根據相應的Java源代碼及其說明語句生成HTML文檔
//javadoc標記:是@開頭的,對javadoc而言,特殊的標記。
(3)在當前目錄下就會產生doc文件夾,裡面有一系列的.html文件
附上代碼:
[java] view plain copy
span style=”font-size:18px;”*/
/**javadoc注釋的內容
*/
public class Hello{
/**屬性上的注釋*/
public String name;
/**這是main方法,是程序的入口
*@param args 用戶輸入參數
*/
public static void main(String[] args){
System.out.println(“Hello World!”);
f1();
}
/** 這是第1個方法,其作用是…*/
public static void f1(){
System.out.println(“f1()!”);
}
}/span
[java] view plain copy
span style=”font-size:18px;”import java.io.IOException;
/**javadoc注釋內容
*@since 1.0
*@version 1.1
*@author Blue Jey
*br鏈接到另一個文檔{@link Hello},就這些
*see Hello
*/
public class HelloWorld{
/**非public,protected 屬性上的注釋不生成*/
public String name;
/**這是main方法,是程序的入口
*@param args 用戶輸入的參數,是數組
*@throws IOException main方法io異常
*/
public static void main(String args[]) throws IOException{
System.out.println(“hello World!”);
f1();
f2(1);
}
/**這是第一個方法,其作用是….
*@deprecated 從版本1.2開始,不再建議使用此方法
*/
public static void f1(){
System.out.println(“fl()!”);
}
/**這是第二個方法,其作用是….
*@return 返回是否OK
*@param i 輸入參數i
*@see Hello
*@throws IOException io異常
*/
public static String f2(int i)throws IOException{
System.out.println(“f1()!”);
return “OK”;
}
} /span
注意:
如果源文件中有用到@version,@author標記,則在執行javadoc命令時,要加-version -author
javadoc -version -author -d doc *.java
(其中用-version用於提取源文件中的版本信息 -author用於提取源文件中的作者信息)
原創文章,作者:QNJD,如若轉載,請註明出處:https://www.506064.com/zh-tw/n/140415.html