java注釋模板
⑴ 如何寫java文檔注釋
如何寫Java文檔注釋(Java Doc Comments)
本文翻譯自How to Write Doc Comments for the Javadoc Tool，但是精簡了一些私以為不重要的東西
本文不討論如何使用javadoc工具自動生成文檔的方法，而是主要探討應該如何去寫文檔注釋
業余時間整理，難免有遺漏或錯誤，如有發現歡迎指正
轉載地址：網頁鏈接
文檔注釋概覽
「文檔注釋」(Java Doc Comments)是專門為了用javadoc工具自動生成文檔而寫的注釋，它是一種帶有特殊功能的注釋。
文檔注釋與一般注釋的最大區別在於起始符號是/**而不是/*或//。
比如：
/**這是文檔注釋*/
/* 這是一般注釋*/
// 這是一般注釋
在一些IDE（比如Eclipse）中，文檔注釋會以不同於普通注釋的顏色高亮顯示。
此外，文檔注釋只負責描述類(class)、介面(interface)、方法(method)、構造器(constructor)、成員欄位(field)。相應地，文檔注釋必須寫在類、介面、方法、構造器、成員欄位前面，而寫在其他位置，比如函數內部，是無效的文檔注釋。
文檔注釋採用HTML語法規則書寫，支持HTML標記(tag)，同時也有一些額外的輔助標記。需要注意的是，這些標記不是給人看的（通常他們的可讀性也不好），他們的作用是為了javadoc工具更好地生成最終文檔。所以，雖然有些標記寫起來麻煩且看著不直觀，還是要老老實實按規矩寫滴。
原文地址：網頁鏈接
⑵ 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
<spanstyle="font-size:18px;">*/
/**javadoc注釋的內容
*/
publicclassHello{
/**屬性上的注釋*/
publicStringname;
/**這是main方法,是程序的入口
*@paramargs用戶輸入參數
*/
publicstaticvoidmain(String[]args){
System.out.println("HelloWorld!");
f1();
}
/**這是第1個方法,其作用是...*/
publicstaticvoidf1(){
System.out.println("f1()！");
}
}</span>
<spanstyle="font-size:18px;">importjava.io.IOException;
/**javadoc注釋內容
*@since1.0
*@version1.1
*@authorBlueJey
*<br>鏈接到另一個文檔{@linkHello},就這些
*seeHello
*/
publicclassHelloWorld{
/**非public，protected屬性上的注釋不生成*/
publicStringname;
/**這是main方法，是程序的入口
*@paramargs用戶輸入的參數，是數組
*@throwsIOExceptionmain方法io異常
*/
publicstaticvoidmain(Stringargs[])throwsIOException{
System.out.println("helloWorld!");
f1();
f2(1);
}
/**這是第一個方法，其作用是....
*@deprecated從版本1.2開始，不再建議使用此方法
*/
publicstaticvoidf1(){
System.out.println("fl()!");
}
/**這是第二個方法，其作用是....
*@return返回是否OK
*@parami輸入參數i
*@seeHello
*@throwsIOExceptionio異常
*/
publicstaticStringf2(inti)throwsIOException{
System.out.println("f1()!");
return"OK";
}
}</span>
[java]view plain
注意：
如果源文件中有用到@version,@author標記，則在執行javadoc命令時，要加-version-author
javadoc-version-author-ddoc*.java
（其中用-version用於提取源文件中的版本信息-author用於提取源文件中的作者信息）
⑶ java注釋若干行的格式
注釋：//表示注釋一行。
/*表示注釋段內容（可以為很多行）*/
public static void main(String [] args){
System.out.println("Hello World1");
//System.out.println("Hello World2");
System.out.println("Hello World3");
/*System.out.println("Hello World4");
System.out.println("Hello World5");/*
}
這樣的話就只會輸出：
Hello World 1
Hello World 3
這樣很好理解吧？
⑷ 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程序中注釋的作用及類型分別是什麼
對於Java注釋我們主要了解三種：
1,// 注釋一行
2,/* ...... */ 注釋若干行
3,/**……*/文檔注釋 /** ...... */ 注釋若干行，並寫入 javadoc文檔
java圖標通常這種注釋的多行寫法如下： /** * ......... * ......... */
⑹ java中如何自動生成注釋
你說的應該是生成javadoc吧?
最簡單方式就是使用命令行, cd到你的項目源代碼目錄下, 輸入如下指令:
javadoc-ddocs-subpackagescom.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不顯示狀態消息
-J<flag>直接將<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的全限定名稱
-tagletpathTaglet的路徑
-charset<charset>用於跨平台查看生成的文檔的字元集。
-helpfile<file>包含幫助鏈接所鏈接到的文件
-linksource以HTML格式生成源文件
-sourcetab<tablength>指定源中每個製表符占據的空格數
-keywords使程序包,類和成員信息附帶HTML元標記
-stylesheetfile<path>用於更改生成文檔的樣式的文件
-docencoding<name>指定輸出的字元編碼
⑺ java注釋的注釋例子
import java.awt.*; //調用awt包
import java.applet.*;
import java.awt.Color; //調用awt中的Color類
public class extends Applet implements Runnable {
Image buffer;// 定義圖像對象
Graphics gContext;// 定義圖形上下文
Thread animate;// 定義一個線程
String s = 這是文字動畫;
int w, h, x, y, size = 12; // 定義整形變數並賦值
/**
* Applet初始化
*
* @see java.applet.Applet
* @return 無
*/
public void init() {
w = getWidth();// 返回組件的當前寬度。
h = getHeight();// 返回組件的當前高度。
buffer = createImage(w, h);// 創建一個寬W高H的圖形區域。 （創建一幅用於雙緩沖的、可在屏幕外繪制的圖像）
gContext = buffer.getGraphics();// 獲得圖像使用的圖形上下文
gContext.setColor(Color.blue);// 設置圖形上下文的當前顏色為藍色
}
/**
* Thread 線程啟動操作
*/
public void start() {
// 開始animate線程
if (animate == null) {
animate = new Thread(this);
animate.start();
}
}
/**
* Thread 線程終止時的處理操作 以釋放資源
*/
public void stop() {
// 結束animate線程
if (animate != null)
animate = null;
}
/**
* Runnable介面的實現
* 執行所需的操作
*/
public void run() {
while (true) {
//X,Y的坐標設定
x = (w - s.length() * size) / 2;
y = (h + size) / 2;
gContext.setFont(new Font(宋體, Font.PLAIN, size));
gContext.drawString(s, x, y);//繪制一串字元s內容的文本
repaint();//重畫圖形
try {
animate.sleep(50);//線程休眠50ms
} catch (InterruptedException e) {// 捕獲異常
}
gContext.clearRect(0, 0, w, h);//通過使用當前繪圖表面的背景色進行填充來清除指定的矩形.0 - 要清除矩形的x 坐標。0 - 要清除矩形的 y 坐標。w - 要清除矩形的寬度。h - 要清除矩形的高度。
if (++size > 40)
size = 12;
}
}
/**
* Applet畫圖操作方法
*
* @see java.applet.Applet
*/
public void paint(Graphics g) {
g.drawImage(buffer, 0, 0, this);//繪制指定的buffer的圖像
}
/**
* Applet刷新操作，重新繪制圖形
*
* @see java.applet.Applet
*/
public void update(Graphics g) {
paint(g);//重新調用paint函數繪制圖形
}
}
⑻ 關於java的注釋模板
這個是希望你往上填的。或者可能可以使用第三方工具替換。標准情況下這個是沒什麼用的。
⑼ idea 如何導入java注釋模板文件
可以了解下idea的livetemplate，非常強大，idea可以將整個IDE的配置都導出來，然後導入