本文目錄一覽:
java代碼注釋所有代碼
好像和另外一個一樣,貼一下:
import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
public class GoodLucky extends JFrame implements ActionListener{
JTextField tf = new JTextField(); //實例化一個文本域
//設置兩個按鈕
JButton b1 = new JButton(“開始”);
JButton b2 = new JButton(“停止”);
boolean isGo = false;
//構造函數
public GoodLucky(){
b1.setActionCommand(“start”);//在開始按鈕上設置一個動作監聽 start
JPanel p = new JPanel(); //實例化一個可視化容器
//將兩個按鈕添加到可視化容器上面,用add方法
p.add(b1);
p.add(b2);
//在兩個按鈕上增加監聽的屬性,自動調用下面的監聽處理方法actionPerformed(ActionEvent e),如果要代碼有更好的可讀性,可用內部類實現動作
//監聽處理。
b1.addActionListener(this);
b2.addActionListener(this);
//將停止按鈕設置為不可編輯(即不可按的狀態)
b2.setEnabled(false);
this.getContentPane().add(tf,”North”); //將上面的文本域放在面板的北方,也就是上面(上北下南左西右東)
this.getContentPane().add(p,”South”); //將可視化容器pannel放在南邊,也就是下面
this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); //設置用戶在此窗體上發起 “close” 時默認執行的操作,參數EXIT_ON_CLOSE是使用 System exit 方法退出應用程序。僅在應用程序中使用
this.setSize(300,200); //設置面板大小,寬和高
this.setLocation(300,300); //設置面板剛開始的出現的位置
Cursor cu = new Cursor(Cursor.HAND_CURSOR); //用指定名稱創建一個新的定製光標對象,參數表示手狀光標類型
this.setCursor(cu); //為指定的光標設置光標圖像,即設置光標圖像為上面所創建的手狀光標類型
this.setVisible(true); //將面板可視化設置為true,即可視,如果為false,即程序運行時面板會隱藏
tf.setText(“welcome you! “); //設置面板的標題為歡迎
this.go(); //調用go方法
}
public void go(){
while(true){ //這裡是死循環,也就是說用戶不點擊停止按鈕的話他一直循環出現隨機數,直到用戶點擊停止按鈕循環才能推出,具體流程在actionPerformed方法中控制。
if(isGo == true){ //上面所定義的isGo的初始值為false,所以程序第一次到此會跳過
String s = “”; //設置空字符串
for(int j = 1; j = 7;j++){ //產生7個隨機數
int i = (int)(Math.random() * 36) + 1;//每個隨機數產生方式,這裡定義靈活,可以自由定義隨機數產生的方式
if(i 10){
s = s + ” 0″ + i; //如果產生的隨機數小於10的話做處理:這裡就牽扯到一個重要的概念,簡單敘述一下:
/*
當一個字符串與一個整型數項相加的意思是連接,上面的s = s + ” 0″ + i的意思是字符串s鏈接0再連接整型i值,而不會導致0和整型的i相加,
產生的效果為s0i,由於s為空字符串(上面定義過的),所以當i小於零時,在個位數前面加上0,比如產生的隨機數i為7的話,顯示效果為 07.
*/
}else{
s = s + ” ” + i; //如果產生的隨機數比10打的話,那麼加上空格顯示,即數字和數字之間有個空格
}
//以上循環循環七次,以保證能出現7個隨機數
}
tf.setText(s); //將產生的隨機數全部顯示在文本域上,用文本域對象tf調用它的設置文本的方法setText(String)實現。
}
//以下為線程延遲
try{
Thread.sleep(10); //線程類同步方法sleep,睡眠方法,括號里的單位為ms。
}catch(java.lang.InterruptedException e){
e.printStackTrace(); //異常捕獲,不用多說。
}
}
}
//以下是上面設置的事件監聽的具體處理辦法,即監聽時間處理方法,自動調用
public void actionPerformed(ActionEvent e){ //傳入一個動作事件的參數e
String s = e.getActionCommand(); //設置字符串s來存儲獲得動作監聽,上面的start
/*
以下這個條件語句塊的作用為:用戶點擊開始後(捕獲start,用方法getActionCommand()),將命令觸發設置為true,從而執行上面的go方法中的循環體(因為循環體中要求isGo參數為true,而初始為false)。
執行循環快產生隨機數,並將開始按鈕不可編輯化,而用戶只可以使用停止按鈕去停止。如果用戶按下停止時,也就是沒有傳入參數“start”的時候,
執行else語句塊中的語句,isGo設置為false,將不執行上面go中的循環語句塊,從而停止產生隨機數,並顯示,並且把開始按鈕設置為可用,而把
停止按鈕設置為不可用,等待用戶按下開始再去開始新一輪循環產生隨機數。
*/
if(s.equals(“start”)){ //如果捕獲到start,也就是用戶觸發了動作監聽器,那麼下面處理
isGo = true; //設置isGo為true
b1.setEnabled(false); //將開始按鈕設置為不可用
b2.setEnabled(true); //將停止按鈕設置為可用
}else{
isGo = false; //將isGo設置為false,isGo為循環標誌位
b2.setEnabled(false); //設置停止按鈕為不可用(注意看是b2,b2是停止按鈕)
b1.setEnabled(true); //設置開始按鈕為可用
}
}
public static void main(String[] args){
new GoodLucky(); //產生類的實例,執行方法
}
}
如何寫好java代碼注釋
寫代碼的時候,有時候,你需要寫一些注釋,把內容相互關聯起來,方便自己或別人看的時候,可以直接找到你關聯的代碼類或者啥的。
這個時候,{@link}與@see,這2個javadoc註解就派上用場了,
不管他具體有什麼功能,咱就只管一個,他可以鏈接代碼,讓注釋看的更清楚易懂。方便你我他。
@see 標籤允許用戶引用其他類的文檔。具體使用方式如下:
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名稱
@see fully-qualified-classname#屬性名稱
我在使用的時候,發現這個只能單獨一行頂頭寫,如果不頂頭寫就不管用了,沒了鏈接的效果。
但是,{@link}這個卻可以隨便放。
具體使用方法和上面那個@see是一樣的。
實際效果,看下面的圖
java 怎樣給源代碼添加註釋
1、單行(single-line)–短注釋://……
單獨行注釋:在代碼中單起一行注釋,
注釋前最好有一行空行,並與其後的代碼具有一樣的縮進層級。如果單行無法完成,則應採用塊注釋。
注釋格式:/*
注釋內容
*/
行頭注釋:在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。
注釋格式://
注釋內容
行尾注釋:尾端(trailing)–極短的注釋,在代碼行的行尾進行注釋。一般與代碼行後空8(至少4)個格,所有注釋必須對齊。
注釋格式:代碼
+
8(至少4)個空格
+
//
注釋內容
2、塊(block)–塊注釋:/*……*/
注釋若干行,通常用於提供文件、方法、數據結構等的意義與用途的說明,或者算法的描述。一般位於一個文件或者一個方法的前面,起到引導的作用,也可以根據需要放在合適的位置。這種域注釋不會出現在HTML報告中。注釋格式通常寫成:
/*
*
注釋內容
*/
3、文檔注釋:/**……*/
注釋若干行,並寫入javadoc文檔。每個文檔注釋都會被置於注釋定界符
/**……*/
…
java中的注釋可分為三種類型
Java中三種類型的注釋:
單行注釋:// 注釋內容
多行注釋:/*… 注釋內容….*/
文本注釋:/**.. 注釋內容….*/
代碼注釋是架起程序設計者與程序閱讀者之間的通信橋樑,最大限度的提高團隊開發合作效率。也是程序代碼可維護性的重要環節之一。所以不是為寫注釋而寫注釋。
備註:簡單的代碼做簡單注釋,注釋內容不大於10個字即可,另外,持久化對象或VO對象的getter、setter方法不需加註釋。
擴展資料:
類(模塊)注釋採用 /** …… */,在每個類(模塊)的頭部要有必要的注釋信息,包括:工程名;類(模塊)編號;命名空間;類可以運行的JDK版本;版本號;作者;創建時間;類(模塊)功能描述(如功能、主要算法、內部各部分之間的關係、該類與其類的關係等,必要時還要有一些如特別的軟硬件要求等說明);主要函數或過程清單及本類(模塊)歷史修改記錄等。
參考資料來源:百度百科-java注釋
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用於提取源文件中的作者信息)
原創文章,作者:UNPB,如若轉載,請註明出處:https://www.506064.com/zh-hant/n/145729.html