⑴ 用java寫一個web項目,一般在類裡面加一些什麼注釋呢(類的開始、中間)
這個沒有固定的格式。只是有個大概的約定。
/**
* Applet初始化 類的作用
* @see java.applet.Applet 類名
* @parameter 參數
* @return 返回值
* @author 作者
* @create time 創建時間
*/
然後可以加上修改時間等等其他的
希望可以解決你的問題。
⑵ 真正的開發中,java代碼要如何注釋
代碼注釋是架起程序設計者與程序閱讀者之間的通信橋梁,最大限度的提高團隊開發合作效率。也是程序代碼可維護性的重要環節之一。所以我們不是為寫注釋而寫注釋。下面說一下我們在訴求網二期開發中使用的代碼注釋規范,供大家參考下。
原則:
1、注釋形式統一
在整個應用程序中,使用具有一致的標點和結構的樣式來構造注釋。如果在其它項目中發現它們的注釋規范與這份文檔不同,按照這份規范寫代碼,不要試圖在既成的規范系統中引入新的規范。
2、注釋內容准確簡潔
內容要簡單、明了、含義准確,防止注釋的多義性,錯誤的注釋不但無益反而有害。
注釋條件:
1、基本注釋(必須加)
(a) 類(介面)的注釋
(b) 構造函數的注釋
(c) 方法的注釋
(d) 全局變數的注釋
(e) 欄位/屬性的注釋
備註:簡單的代碼做簡單注釋,注釋內容不大於10個字即可,另外,持久化對象或VO對象的getter、setter方法不需加註釋。具體的注釋格式請參考下面舉例。
2、特殊必加註釋(必須加)
(a) 典型演算法必須有注釋。
(b) 在代碼不明晰處必須有注釋。
(c) 在代碼修改處加上修改標識的注釋。
(d) 在循環和邏輯分支組成的代碼中加註釋。
(e) 為他人提供的介面必須加詳細注釋。
備註:此類注釋格式暫無舉例。具體的注釋格式自行定義,要求注釋內容准確簡潔。
注釋格式:
1、單行(single-line)注釋:「//……」
2、塊(block)注釋:「/*……*/」
3、文檔注釋:「/**……*/」
4、javadoc 注釋標簽語法
@author 對類的說明標明開發該類模塊的作者
@version 對類的說明標明該類模塊的版本
@see 對類、屬性、方法的說明參考轉向,也就是相關主題
@param 對方法的說明對方法中某參數的說明
@return 對方法的說明對方法返回值的說明
@exception 對方法的說明對方法可能拋出的異常進行說明
⑶ 請問 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
<spanstyle="font-size:18px;">*/
/**javadoc注釋的內容
*/
publicclassHello{
/**屬性上的注釋*/
publicStringname;
/**這是main方法,是程序的入口
*@paramargs用戶輸入參數
*/
publicstaticvoidmain(String[]args){
System.out.println("HelloWorld!");
f1();
}
/**這是第1個方法,其作用是...*/
publicstaticvoidf1(){
System.out.println("f1()!");
}
}</span>
[java]view plain
<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>
注意:
如果源文件中有用到@version,@author標記,則在執行javadoc命令時,要加-version-author
javadoc-version-author-ddoc*.java
(其中用-version用於提取源文件中的版本信息-author用於提取源文件中的作者信息)
⑸ java方法名前注釋問題
Java註解是附加在代碼中的一些元信息,用於一些工具在編譯、運行時進行解析和使用,起到說明、配置的功能。
註解不會也不能影響代碼的實際邏輯,僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。
1、元註解
元註解是指註解的註解。包括 @Retention @Target @Document @Inherited四種。
1.1、@Retention: 定義註解的保留策略
@Retention(RetentionPolicy.SOURCE) //註解僅存在於源碼中,在class位元組碼文件中不包含
@Retention(RetentionPolicy.CLASS) // 默認的保留策略,註解會在class位元組碼文件中存在,但運行時無法獲得,
@Retention(RetentionPolicy.RUNTIME) // 註解會在class位元組碼文件中存在,在運行時可以通過反射獲取到
1.2、@Target:定義註解的作用目標
@Target(ElementType.TYPE) //介面、類、枚舉、註解
@Target(ElementType.FIELD) //欄位、枚舉的常量
@Target(ElementType.METHOD) //方法
@Target(ElementType.PARAMETER) //方法參數
@Target(ElementType.CONSTRUCTOR) //構造函數
@Target(ElementType.LOCAL_VARIABLE)//局部變數
@Target(ElementType.ANNOTATION_TYPE)//註解
@Target(ElementType.PACKAGE) ///包
由以上的源碼可以知道,他的elementType 可以有多個,一個註解可以為類的,方法的,欄位的等等
1.3、@Document:說明該註解將被包含在javadoc中。
1.4、@Inherited:說明子類可以繼承父類中的該註解。
⑹ JAVA的注釋問題
兩種可能:
1.項目引用了別人的源碼,用這種方式可以表示尊重對方的版權,通常可能樓主也遇到過就是我們去一些別的博客或者站點看文章的時候,文章的開頭或者結尾都有一句提示說「如轉載,請註明文章來自於XXX」對吧,源碼也是如此,因為生成doc後這段注釋代碼會存在於doc中,這樣的話源碼的所有者只要源碼是開源的並且尊重了這種聲明協議,也就不會再追究責任了。
2.自己的項目頭,通常使用的一些團隊開發軟體比如cvs或者開發ide在你新建一個類的時候自動產生這段代碼,說明源碼的公司等信息。
⑺ 如何編寫類的javadoc注釋
代碼注釋是架起程序設計者與程序閱讀者之間的通信橋梁,最大限度的提高團隊開發合作效率。也是程序代碼可維護性的重要環節之一。所以我們不是為寫注釋而寫注釋。下面說一下我們在訴求網二期開發中使用的代碼注釋規范,供大家參考下。
原則:
1、注釋形式統一
在整個應用程序中,使用具有一致的標點和結構的樣式來構造注釋。如果在其它項目中發現它們的注釋規范與這份文檔不同,按照這份規范寫代碼,不要試圖在既成的規范系統中引入新的規范。
2、注釋內容准確簡潔
內容要簡單、明了、含義准確,防止注釋的多義性,錯誤的注釋不但無益反而有害。
注釋條件:
1、基本注釋(必須加)
(a) 類(介面)的注釋
(b) 構造函數的注釋
(c) 方法的注釋
(d) 全局變數的注釋
(e) 欄位/屬性的注釋
備註:簡單的代碼做簡單注釋,注釋內容不大於10個字即可,另外,持久化對象或VO對象的getter、setter方法不需加註釋。具體的注釋格式請參考下面舉例。
2、特殊必加註釋(必須加)
(a) 典型演算法必須有注釋。
(b) 在代碼不明晰處必須有注釋。
(c) 在代碼修改處加上修改標識的注釋。
(d) 在循環和邏輯分支組成的代碼中加註釋。
(e) 為他人提供的介面必須加詳細注釋。
備註:此類注釋格式暫無舉例。具體的注釋格式自行定義,要求注釋內容准確簡潔。
注釋格式:
1、單行(single-line)注釋:「//……」
2、塊(block)注釋:「/*……*/」
3、文檔注釋:「/**……*/」
4、javadoc 注釋標簽語法
@author 對類的說明標明開發該類模塊的作者
@version 對類的說明標明該類模塊的版本
@see 對類、屬性、方法的說明參考轉向,也就是相關主題
@param 對方法的說明對方法中某參數的說明
@return 對方法的說明對方法返回值的說明
@exception 對方法的說明對方法可能拋出的異常進行說明
⑻ java注釋的java註解
Annotation(註解)是JDK5.0及以後版本引入的。它可以用於創建文檔,跟蹤代碼中的依賴性,甚至執行基本編譯時檢查。註解是以『@註解名』在代碼中存在的,根據註解參數的個數,我們可以將註解分為:標記註解、單值註解、完整註解三類。它們都不會直接影響到程序的語義,只是作為註解(標識)存在,我們可以通過反射機制編程實現對這些元數據的訪問。另外,你可以在編譯時選擇代碼里的註解是否只存在於源代碼級,或者它也能在class文件中出現。
元數據的作用
如果要對於元數據的作用進行分類,大致可分為三類:
編寫文檔:通過代碼里標識的元數據生成文檔。
代碼分析:通過代碼里標識的元數據對代碼進行分析。
編譯檢查:通過代碼里標識的元數據讓編譯器能實現基本的編譯檢查 @Override
Java代碼
packagecom.iwtxokhtd.annotation;
/**
* 測試Override註解
*@authorAdministrator
*
*/
publicclassOverrideDemoTest {
//@Override
publicString tostring(){
return測試註解;
}
}
@Deprecated的作用是對不應該在使用的方法添加註解,當編程人員使用這些方法時,將會在編譯時顯示提示信息,它與javadoc里的@deprecated標記有相同的功能,准確的說,它還不如javadoc @deprecated,因為它不支持參數,使用@Deprecated的示例代碼示例如下:
Java代碼
packagecom.iwtxokhtd.annotation;
/**
* 測試Deprecated註解
*@authorAdministrator
*
*/
publicclassDeprecatedDemoTest {
publicstaticvoidmain(String[] args) {
//使用DeprecatedClass里聲明被過時的方法
DeprecatedClass.DeprecatedMethod();
}
}
classDeprecatedClass{
@Deprecated
() {
}
}
@SuppressWarnings,其參數有:
deprecation,使用了過時的類或方法時的警告
unchecked,執行了未檢查的轉換時的警告
fallthrough,當 Switch 程序塊直接通往下一種情況而沒有 Break 時的警告
path,在類路徑、源文件路徑等中有不存在的路徑時的警告
serial,當在可序列化的類上缺少serialVersionUID 定義時的警告
finally ,任何 finally 子句不能正常完成時的警告
all,關於以上所有情況的警告 packagecom.iwtxokhtd.annotation;
importjava.util.ArrayList;
importjava.util.List;
{
publicstaticListlist=newArrayList();
@SuppressWarnings(unchecked)
publicvoidadd(String data){
list.add(data);

⑼ java注釋的自定義
它類似於新創建一個介面類文件,但為了區分,我們需要將它聲明為@interface,如下例:
Java代碼
packagecom.iwtxokhtd.annotation;
public@interfaceNewAnnotation {
}
使用自定義的註解類型
Java代碼
packagecom.iwtxokhtd.annotation;
publicclassAnnotationTest {
@NewAnnotation
publicstaticvoidmain(String[] args) {
}
}
為自定義註解添加變數
Java代碼
packagecom.iwtxokhtd.annotation;
public@interfaceAnnotation {
String value();
}
Java代碼
publicclassAnnotationTest {
@NewAnnotation(main method)
publicstaticvoidmain(String[] args) {
saying();
}
@NewAnnotation(value = say method)
publicstaticvoidsaying() {
}
}
定義一個枚舉類型,然後將參數設置為該枚舉類型,並賦予默認值
public@interfaceGreeting {
publicenum FontColor {
BLUE,RED,GREEN
};
String name();
FontColor fontColor()defaultFontColor.RED;
}
這里有兩種選擇,其實變數也就是在賦予默認值的參數上,我們可以選擇使用該默認值,也可以重新設置一個值來替換默認值
Java代碼
publicclassAnnotationTest {
@NewAnnotation(main method)
publicstaticvoidmain(String[] args) {
saying();
sayHelloWithDefaultFontColor();
sayHelloWithRedFontColor();
}
@NewAnnotation(say method)
publicstaticvoidsaying() {
}
// 此時的fontColor為默認的RED
@Greeting(name = defaultfontcolor)
() {
}
@Greeting(name = notdefault, fontColor = Greeting.FontColor.BLUE)
() {
} 1.1. 限制註解的使用范圍
用@Target指定ElementType屬性
Java代碼(jdk)
packagejava.lang.annotation;
public enum ElementType {
TYPE,
// 用於類,介面,枚舉但不能是註解
FIELD,
// 欄位上,包括枚舉值
METHOD,
// 方法,不包括構造方法
PARAMETER,
// 方法的參數
CONSTRUCTOR,
//構造方法
LOCAL_VARIABLE,
// 本地變數或catch語句
ANNOTATION_TYPE,
// 註解類型(無數據)
PACKAGE
// Java包
}
1.2. 註解保持性策略
Java代碼
//限制註解使用范圍
@Target({ElementType.METHOD,ElementType.CONSTRUCTOR})
public @interface Greeting {
//使用枚舉類型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
在Java編譯器編譯時,它會識別在源代碼里添加的註解是否還會保留,這就是RetentionPolicy。下面是Java定義的RetentionPolicy枚舉:
編譯器的處理有三種策略:
將註解保留在編譯後的類文件中,並在第一次載入類時讀取它
將註解保留在編譯後的類文件中,但是在運行時忽略它
按照規定使用註解,但是並不將它保留到編譯後的類文件中
Java代碼
packagejava.lang.annotation;
public enum RetentionPolicy{
SOURCE,
// 此類型會被編譯器丟棄
CLASS,
// 此類型註解會保留在class文件中,但JVM會忽略它
RUNTIME
// 此類型註解會保留在class文件中,JVM會讀取它
}
Java代碼
//讓保持性策略為運行時態,即將註解編碼到class文件中,讓虛擬機讀取
@Retention(RetentionPolicy.RUNTIME)
public @interface Greeting {
//使用枚舉類型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
1.3. 文檔化功能
Java提供的Documented元註解跟Javadoc的作用是差不多的,其實它存在的好處是開發人員可以定製Javadoc不支持的文檔屬性,並在開發中應用。它的使用跟前兩個也是一樣的,簡單代碼示例如下:
Java代碼
//讓它定製文檔化功能
//使用此註解時必須設置RetentionPolicy為RUNTIME
@Documented
public @interface Greeting {
//使用枚舉類型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
1.4. 標注繼承
Java代碼
//讓它允許繼承,可作用到子類
@Inherited
public @interface Greeting {
//使用枚舉類型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
2. 讀取註解信息
屬於重點,在系統中用到註解許可權時非常有用,可以精確控制許可權的粒度
注意:要想使用反射去讀取註解,必須將Retention的值選為Runtime
Java代碼
packagecom.iwtxokhtd.annotation;
importjava.lang.annotation.Annotation;
importjava.lang.reflect.Method;
//讀取註解信息
{
publicstaticvoidmain(String[] args)throws Exception {
// 測試AnnotationTest類,得到此類的類對象
Class c = Class.forName(com.iwtxokhtd.annotation.AnnotationTest);
// 獲取該類所有聲明的方法
Method[] methods =c.getDeclaredMethods();
// 聲明註解集合
Annotation[] annotations;
// 遍歷所有的方法得到各方法上面的註解信息
for(Method method : methods) {
// 獲取每個方法上面所聲明的所有註解信息
annotations =method.getDeclaredAnnotations();
// 再遍歷所有的註解,列印其基本信息
System.out.println(method.getName());
for(Annotation an :annotations) {
System.out.println(方法名為: + method.getName()+ 其上面的註解為:
+an.annotationType().getSimpleName());
Method[] meths =an.annotationType().getDeclaredMethods();
// 遍歷每個註解的所有變數
for(Method meth :meths) {
System.out.println(註解的變數名為: + meth.getName 注釋有三種:// /* */ /** */ 前兩種編譯器直接跳過,從來不閱讀,第三種編譯器是可以看懂的,當你使用javadoc這樣的命令時會用到,用來生成API時用的。
註解:這東東完全就是給編譯器看的。 比如@Ovrride表示這個方法是重寫了父類中的方法,而不是自定義的,所以這個時候編譯器會去檢查你的方法名是否和父類一樣,是否寫錯了。
以上是不同的概念
