1.5.2 java編程規(guī)范
軟件開發(fā)是一個集體協(xié)作的過程,程序員之間的代碼是經(jīng)常要進(jìn)行交換閱讀的,因此,java源程序有一些約定成俗的命名規(guī)定,主要目的是為了提高java程序的可讀性。
包名:包名是全小寫的名詞,中間可以由點分隔開,例如:java.awt.event;
類名:首字母大寫,通常由多個單詞合成一個類名,要求每個單詞的首字母也要大寫,例如class HelloWorldApp;
接口名:命名規(guī)則與類名相同,例如interface Collection;
方法名:往往由多個單詞合成,第一個單詞通常為動詞,首字母小寫,中間的每個單詞的首字母都要大寫,例如:balanceAccount, isButtonPressed;
變量名:全小寫,一般為名詞,例如:length;
常量名:基本數(shù)據(jù)類型的常量名為全大寫,如果是由多個單詞構(gòu)成,可以用下劃線隔開,例如:int YEAR, int WEEK_OF_MONTH;如果是對象類型的常量,則是大小寫混合,由大寫字母把單詞隔開。
1.5.3 java幫助文檔
java中所有類庫的介紹都保存在java幫助文檔中,程序員在編程過程中,必須查閱該幫助文檔,了解系統(tǒng)提供的類的功能、成員方法、成員變量等等信息以后,才能夠更好的編程。同時,java開發(fā)工具包(JDK)提供了
"java"、"javac"、"javadoc"、
"appletviewer"等命令,在java幫助文檔中也對此進(jìn)行了詳細(xì)的介紹。java幫助文檔是以HTML文件的形式組織,通常是安裝在JDK目錄下的docs子目錄中的index.html文件,所以用瀏覽器就可以進(jìn)行查閱。例如JDK是安裝在D:\jdk1.3目錄下面,則用瀏覽器打開D:\jdk1.3\docs\index.html文件,就可以看到圖1_5_1所示的幫助文檔。
如果希望查閱JDK的命令,則可以選擇"Tool Documentation",如圖1_5_2紅字所示。
此時瀏覽器就會把java、javac、javadoc、appletviewer等命令列出來,如圖1_5_3。
但是大多時時候,我們需要查閱的是類庫的文檔,因此需要在"D:\jdk1.3\docs\index.html"文件中選擇"Java 2 Platform API Specification",如圖1_5_4中紅字所示。
1.5.4 java注釋
單行注釋:從"http://"開始到本行結(jié)束的內(nèi)容都是注釋,例如:
//這是一行單行注釋
//則是另一行單行注釋
多行注釋:在"/*"和"*/"之間的所有內(nèi)容都是注釋,例如:
/*這是一段注釋分布在多行之中*/
文檔注釋:在注釋方面java提供一種C/C++所不具有的文檔注釋方式。其核心思想是當(dāng)程序員編完程序以后,可以通過JDK提供的javadoc命令,生成所編程序的API文檔,而該文檔中的內(nèi)容主要就是從文檔注釋中提取的。該API文檔以HTML文件的形式出現(xiàn),與java幫助文檔的風(fēng)格與形式完全一致。凡是在"/**"和"*/"之間的內(nèi)容都是文檔注釋。例如下面的DocTest.java文件:
/** 這是一個文檔注釋的例子,主要介紹下面這個類 */
public class DocTest{
/** 變量注釋,下面這個變量主要是充當(dāng)整數(shù)計數(shù) */
public int i;
/* 方法注釋,下面這個方法的主要功能是計數(shù) */
public void count( ) {}
} 來源:www.examda.com
通過在命令行下面運行"javadoc -d . DocTest.java",就生成了介紹類DocTest的index.html文件,用瀏覽器瀏覽結(jié)果即可,注意到DocTest.java文件中的文檔注釋的內(nèi)容都出現(xiàn)在該index.html文件中。
軟件開發(fā)是一個集體協(xié)作的過程,程序員之間的代碼是經(jīng)常要進(jìn)行交換閱讀的,因此,java源程序有一些約定成俗的命名規(guī)定,主要目的是為了提高java程序的可讀性。
包名:包名是全小寫的名詞,中間可以由點分隔開,例如:java.awt.event;
類名:首字母大寫,通常由多個單詞合成一個類名,要求每個單詞的首字母也要大寫,例如class HelloWorldApp;
接口名:命名規(guī)則與類名相同,例如interface Collection;
方法名:往往由多個單詞合成,第一個單詞通常為動詞,首字母小寫,中間的每個單詞的首字母都要大寫,例如:balanceAccount, isButtonPressed;
變量名:全小寫,一般為名詞,例如:length;
常量名:基本數(shù)據(jù)類型的常量名為全大寫,如果是由多個單詞構(gòu)成,可以用下劃線隔開,例如:int YEAR, int WEEK_OF_MONTH;如果是對象類型的常量,則是大小寫混合,由大寫字母把單詞隔開。
1.5.3 java幫助文檔
java中所有類庫的介紹都保存在java幫助文檔中,程序員在編程過程中,必須查閱該幫助文檔,了解系統(tǒng)提供的類的功能、成員方法、成員變量等等信息以后,才能夠更好的編程。同時,java開發(fā)工具包(JDK)提供了
"java"、"javac"、"javadoc"、
"appletviewer"等命令,在java幫助文檔中也對此進(jìn)行了詳細(xì)的介紹。java幫助文檔是以HTML文件的形式組織,通常是安裝在JDK目錄下的docs子目錄中的index.html文件,所以用瀏覽器就可以進(jìn)行查閱。例如JDK是安裝在D:\jdk1.3目錄下面,則用瀏覽器打開D:\jdk1.3\docs\index.html文件,就可以看到圖1_5_1所示的幫助文檔。
如果希望查閱JDK的命令,則可以選擇"Tool Documentation",如圖1_5_2紅字所示。
此時瀏覽器就會把java、javac、javadoc、appletviewer等命令列出來,如圖1_5_3。
但是大多時時候,我們需要查閱的是類庫的文檔,因此需要在"D:\jdk1.3\docs\index.html"文件中選擇"Java 2 Platform API Specification",如圖1_5_4中紅字所示。
1.5.4 java注釋
單行注釋:從"http://"開始到本行結(jié)束的內(nèi)容都是注釋,例如:
//這是一行單行注釋
//則是另一行單行注釋
多行注釋:在"/*"和"*/"之間的所有內(nèi)容都是注釋,例如:
/*這是一段注釋分布在多行之中*/
文檔注釋:在注釋方面java提供一種C/C++所不具有的文檔注釋方式。其核心思想是當(dāng)程序員編完程序以后,可以通過JDK提供的javadoc命令,生成所編程序的API文檔,而該文檔中的內(nèi)容主要就是從文檔注釋中提取的。該API文檔以HTML文件的形式出現(xiàn),與java幫助文檔的風(fēng)格與形式完全一致。凡是在"/**"和"*/"之間的內(nèi)容都是文檔注釋。例如下面的DocTest.java文件:
/** 這是一個文檔注釋的例子,主要介紹下面這個類 */
public class DocTest{
/** 變量注釋,下面這個變量主要是充當(dāng)整數(shù)計數(shù) */
public int i;
/* 方法注釋,下面這個方法的主要功能是計數(shù) */
public void count( ) {}
} 來源:www.examda.com
通過在命令行下面運行"javadoc -d . DocTest.java",就生成了介紹類DocTest的index.html文件,用瀏覽器瀏覽結(jié)果即可,注意到DocTest.java文件中的文檔注釋的內(nèi)容都出現(xiàn)在該index.html文件中。