java第10講編程規(guī)范和程序調(diào)試課件

第10章編程規(guī)范和程序調(diào)試2022/11/211第10章編程規(guī)范和程序調(diào)試2022/11/211本章總體綱要編程規(guī)范文檔注釋程序調(diào)試2022/11/212本章總體綱要編程規(guī)范2022/11/212Java編程風(fēng)格的指導(dǎo)方針指導(dǎo)方針是可以被打破，但要求是確實所需要的，例如增加可讀性沒有標(biāo)準(zhǔn)可以做到完美無缺，也沒有標(biāo)準(zhǔn)可以做到適用于所有的應(yīng)用指導(dǎo)方針一般是為了:增加可讀性、程序的可理解性，從而提高程序的可維護(hù)性以及程序代碼質(zhì)量2022/11/213Java編程風(fēng)格的指導(dǎo)方針指導(dǎo)方針是可以被打破，但要求是確實命名規(guī)范良好的命名規(guī)范可以增強(qiáng)程序的可讀性可以給標(biāo)識符提供功能/屬性上的一些額外信息—例如:是否是常量、類、包等。這些信息對理解程序非常有幫助2022/11/214命名規(guī)范良好的命名規(guī)范可以增強(qiáng)程序的可讀性2022/11/2問題?命名規(guī)范應(yīng)當(dāng)包含哪些內(nèi)容?2022/11/215問題?命名規(guī)范應(yīng)當(dāng)包含哪些內(nèi)容?2022/11/215命名規(guī)范內(nèi)容包文件類/接口方法變量常量2022/11/216命名規(guī)范內(nèi)容包2022/11/216包的命名規(guī)范包的名稱一般全部采用小寫包名的前綴一般是域名單詞序列的逆序示例com.sun.engcom.apple.quicktimeedu.cmu.cs.bovik.cheese2022/11/217包的命名規(guī)范包的名稱一般全部采用小寫2022/11/217文件的命名規(guī)范Java源程序文件的命名規(guī)范必須與該文件中public類的類名同名后綴必須是.java2022/11/218文件的命名規(guī)范Java源程序文件的命名規(guī)范2022/11/2類/接口的命名規(guī)范類名一般是名詞/名詞詞組:每個單詞的首字母大寫，其它字母小寫類名應(yīng)當(dāng)盡量簡單，而且其含義能夠盡量準(zhǔn)確地刻畫該類的含義一般采用全稱—盡量少用縮寫詞(除非該縮寫詞被廣泛使用)示例J_ClockJ_CircleTimeImageSprite(圖版精靈)2022/11/219類/接口的命名規(guī)范類名一般是名詞/名詞詞組:每個單詞的首字方法的命名規(guī)范方法名一般是/動詞/動詞性詞組,首字母小寫中間單詞的首字母大寫，其它字母小寫示例:run();getBackground();getTime();2022/11/2110方法的命名規(guī)范方法名一般是/2022/11/2110盡量應(yīng)用常用詞盡量應(yīng)用簡單的、常用的單詞示例:get/set first/lastadd/remove up/downcreate/destroy min/maxstart/stop next/previousinsert/delete old/newincrement/decrement open/closeold/new show/hidebegin/end

2022/11/2111盡量應(yīng)用常用詞盡量應(yīng)用簡單的、常用的單詞2022/11/21變量的命名規(guī)范變量名的首字母小寫中間單詞的首字母大寫，其它字母小寫變量名的首字母盡量不要用字符:_

或$變量名應(yīng)當(dāng)簡短、有含義、且便于記憶示例:inti;charc;doublewidthBox;2022/11/2112變量的命名規(guī)范變量名的首字母小寫2022/11/2112變量的命名規(guī)范變量名常常由表示其所扮演的角色與數(shù)據(jù)類型組成示例:

PointstartingPoint,centerPoint;NameloginName;2022/11/2113變量的命名規(guī)范變量名常常由表示其所扮演的角色與數(shù)據(jù)類型組成2常量的命名規(guī)范常量名一般全大寫，單詞之間用下劃線分隔(“_”)示例:staticfinalintMIN_WIDTH=4;staticfinalintMAX_WIDTH=999;2022/11/2114常量的命名規(guī)范常量名一般全大寫，單詞之間用下劃線分隔(“_編輯方法特殊字符行數(shù)/每行的字符數(shù)縮排方式(Indentation)空白符/行2022/11/2115編輯方法特殊字符2022/11/2115語句書寫——關(guān)鍵保證代碼的簡單性2022/11/2116語句書寫——關(guān)鍵保證代碼的簡單性2022/11/2116文件組織源程序文件一般采用如下的組織順序:最開始一般是注釋package和import語句類和接口的定義2022/11/2117文件組織源程序文件一般采用如下的組織順序:2022/11/2本章總體綱要編程規(guī)范文檔注釋程序調(diào)試2022/11/2118本章總體綱要編程規(guī)范2022/11/2118javadocJavadoc

是一種從文檔注釋生成HTML幫助文件的工具文檔注釋介于/**和*/之間示例/**Sortsintegerarrayusing<em>MySort</em>algorithm*/2022/11/2119javadocJavadoc是一種從文檔注釋生成HTML幫文檔注釋的一般格式示例:/***Thisisthedescriptionpartofadoccomment**@tagCommentforthetag*/2022/11/2120文檔注釋的一般格式示例:2022/11/2120常用的javadoc文檔標(biāo)簽@author@param@return@see@throws@deprecated@link@since@version2022/11/2121常用的javadoc文檔標(biāo)簽@author@throws運行javadoc在命令行下執(zhí)行:javadoc

optionspackagessourcesoptions:選項列表packages

:包列表sources

:源文件列表示例:javadoc

-d.-authorTime3.java2022/11/2122運行javadoc在命令行下執(zhí)行:2022/11/2122本章總體綱要編程規(guī)范文檔注釋程序調(diào)試2022/11/2123本章總體綱要編程規(guī)范2022/11/2123assert語句第一種格式assert布爾表達(dá)式;第二種格式assert布爾表達(dá)式:字符串;注意事項2022/11/2124assert語句第一種格式2022/11/2124作業(yè)習(xí)題10.82022/11/2125作業(yè)習(xí)題10.82022/11/2125本課件使用要求使用本課件，必須注明引用(具體見下一個幻燈片)書及課件均可能出現(xiàn)一些錯誤和缺陷，懇切希望廣大讀者特別是講授此課程的老師批評指正2022/11/2126本課件使用要求使用本課件，必須注明引用(具體見下一個幻燈片)引用聲明本課件來源于(或參考了)下面的書及其課件:雍俊海.《Java程序設(shè)計教程》.北京:清華大學(xué)出版社,2007.2022/11/2127引用聲明本課件來源于(或參考了)下面的書及其課件:2022/免責(zé)聲明請合法使用課件，其用途應(yīng)當(dāng)合法有益而且不應(yīng)對任何人造成任何傷害或損失同時請注意教材作者及出版社沒有對本課件作出任何承諾與保證2022/11/2128免責(zé)聲明請合法使用課件，其用途應(yīng)當(dāng)合法有益而且不應(yīng)對任何人造參考文獻(xiàn)本課件的參考文獻(xiàn)與下面書的參考文獻(xiàn)相同雍俊海.Java程序設(shè)計教程.北京:清華大學(xué)出版社,2007.雍俊海.Java程序設(shè)計習(xí)題集(含參考答案).北京:清華大學(xué)出版社,2006.雍俊海.Java程序設(shè)計.北京:清華大學(xué)出版社,2004.2022/11/2129參考文獻(xiàn)本課件的參考文獻(xiàn)與下面書的參考文獻(xiàn)相同2022/11雍俊海編寫過的教材和教參雍俊海.計算機(jī)動畫算法與編程基礎(chǔ).北京:清華大學(xué)出版社.2008.雍俊海.Java程序設(shè)計.北京:清華大學(xué)出版社.2008.雍俊海.Java程序設(shè)計教程(第2版).北京:清華大學(xué)出版社.2007.雍俊海.Java程序設(shè)計習(xí)題集(含參考答案).北京:清華大學(xué)出版社,2006.雍俊海.Java程序設(shè)計.北京:清華大學(xué)出版社.2004.

2022/11/2130雍俊海編寫過的教材和教參雍俊海.計算機(jī)動畫算法與編程基礎(chǔ).雍俊海編寫過的教材和教參雍俊海.計算機(jī)動畫算法與編程基礎(chǔ).北京:清華大學(xué)出版社.2008.2022/11/2131雍俊海編寫過的教材和教參雍俊海.計算機(jī)動畫算法與編程基礎(chǔ).雍俊海編寫過的教材和教參雍俊海.Java程序設(shè)計.北京:清華大學(xué)出版社,2008.2022/11/2132雍俊海編寫過的教材和教參雍俊海.Java程序設(shè)計.北京:雍俊海編寫過的教材和教參雍俊海.《Java程序設(shè)計教程》.

清華大學(xué)出版社,2007.普通高等教育精品教材普通高等教育“十一五”國家級規(guī)劃教材2022/11/2133雍俊海編寫過的教材和教參雍俊海.普通高等教育精品教材普通高等雍俊海編寫過的教材和教參雍俊海.《Java程序設(shè)計習(xí)題集（含參考答案）》.

清華大學(xué)出版社,2006.2022/11/2134雍俊海編寫過的教材和教參雍俊海.2022/11/2134雍俊海編寫過的教材和教參雍俊海.JAVA程序設(shè)計.北京:清華大學(xué)出版社.2004.2022/11/2135雍俊海編寫過的教材和教參雍俊海.JAVA程序設(shè)計.北京:謝謝請多指教2022/11/2136謝謝請多指教2022/11/2136第10章編程規(guī)范和程序調(diào)試2022/11/2137第10章編程規(guī)范和程序調(diào)試2022/11/211本章總體綱要編程規(guī)范文檔注釋程序調(diào)試2022/11/2138本章總體綱要編程規(guī)范2022/11/212Java編程風(fēng)格的指導(dǎo)方針指導(dǎo)方針是可以被打破，但要求是確實所需要的，例如增加可讀性沒有標(biāo)準(zhǔn)可以做到完美無缺，也沒有標(biāo)準(zhǔn)可以做到適用于所有的應(yīng)用指導(dǎo)方針一般是為了:增加可讀性、程序的可理解性，從而提高程序的可維護(hù)性以及程序代碼質(zhì)量2022/11/2139Java編程風(fēng)格的指導(dǎo)方針指導(dǎo)方針是可以被打破，但要求是確實命名規(guī)范良好的命名規(guī)范可以增強(qiáng)程序的可讀性可以給標(biāo)識符提供功能/屬性上的一些額外信息—例如:是否是常量、類、包等。這些信息對理解程序非常有幫助2022/11/2140命名規(guī)范良好的命名規(guī)范可以增強(qiáng)程序的可讀性2022/11/2問題?命名規(guī)范應(yīng)當(dāng)包含哪些內(nèi)容?2022/11/2141問題?命名規(guī)范應(yīng)當(dāng)包含哪些內(nèi)容?2022/11/215命名規(guī)范內(nèi)容包文件類/接口方法變量常量2022/11/2142命名規(guī)范內(nèi)容包2022/11/216包的命名規(guī)范包的名稱一般全部采用小寫包名的前綴一般是域名單詞序列的逆序示例com.sun.engcom.apple.quicktimeedu.cmu.cs.bovik.cheese2022/11/2143包的命名規(guī)范包的名稱一般全部采用小寫2022/11/217文件的命名規(guī)范Java源程序文件的命名規(guī)范必須與該文件中public類的類名同名后綴必須是.java2022/11/2144文件的命名規(guī)范Java源程序文件的命名規(guī)范2022/11/2類/接口的命名規(guī)范類名一般是名詞/名詞詞組:每個單詞的首字母大寫，其它字母小寫類名應(yīng)當(dāng)盡量簡單，而且其含義能夠盡量準(zhǔn)確地刻畫該類的含義一般采用全稱—盡量少用縮寫詞(除非該縮寫詞被廣泛使用)示例J_ClockJ_CircleTimeImageSprite(圖版精靈)2022/11/2145類/接口的命名規(guī)范類名一般是名詞/名詞詞組:每個單詞的首字方法的命名規(guī)范方法名一般是/動詞/動詞性詞組,首字母小寫中間單詞的首字母大寫，其它字母小寫示例:run();getBackground();getTime();2022/11/2146方法的命名規(guī)范方法名一般是/2022/11/2110盡量應(yīng)用常用詞盡量應(yīng)用簡單的、常用的單詞示例:get/set first/lastadd/remove up/downcreate/destroy min/maxstart/stop next/previousinsert/delete old/newincrement/decrement open/closeold/new show/hidebegin/end

2022/11/2147盡量應(yīng)用常用詞盡量應(yīng)用簡單的、常用的單詞2022/11/21變量的命名規(guī)范變量名的首字母小寫中間單詞的首字母大寫，其它字母小寫變量名的首字母盡量不要用字符:_

或$變量名應(yīng)當(dāng)簡短、有含義、且便于記憶示例:inti;charc;doublewidthBox;2022/11/2148變量的命名規(guī)范變量名的首字母小寫2022/11/2112變量的命名規(guī)范變量名常常由表示其所扮演的角色與數(shù)據(jù)類型組成示例:

PointstartingPoint,centerPoint;NameloginName;2022/11/2149變量的命名規(guī)范變量名常常由表示其所扮演的角色與數(shù)據(jù)類型組成2常量的命名規(guī)范常量名一般全大寫，單詞之間用下劃線分隔(“_”)示例:staticfinalintMIN_WIDTH=4;staticfinalintMAX_WIDTH=999;2022/11/2150常量的命名規(guī)范常量名一般全大寫，單詞之間用下劃線分隔(“_編輯方法特殊字符行數(shù)/每行的字符數(shù)縮排方式(Indentation)空白符/行2022/11/2151編輯方法特殊字符2022/11/2115語句書寫——關(guān)鍵保證代碼的簡單性2022/11/2152語句書寫——關(guān)鍵保證代碼的簡單性2022/11/2116文件組織源程序文件一般采用如下的組織順序:最開始一般是注釋package和import語句類和接口的定義2022/11/2153文件組織源程序文件一般采用如下的組織順序:2022/11/2本章總體綱要編程規(guī)范文檔注釋程序調(diào)試2022/11/2154本章總體綱要編程規(guī)范2022/11/2118javadocJavadoc

是一種從文檔注釋生成HTML幫助文件的工具文檔注釋介于/**和*/之間示例/**Sortsintegerarrayusing<em>MySort</em>algorithm*/2022/11/2155javadocJavadoc是一種從文檔注釋生成HTML幫文檔注釋的一般格式示例:/***Thisisthedescriptionpartofadoccomment**@tagCommentforthetag*/2022/11/2156文檔注釋的一般格式示例:2022/11/2120常用的javadoc文檔標(biāo)簽@author@param@return@see@throws@deprecated@link@since@version2022/11/2157常用的javadoc文檔標(biāo)簽@author@throws運行javadoc在命令行下執(zhí)行:javadoc

optionspackagessourcesoptions:選項列表packages

:包列表sources

:源文件列表示例:javadoc

-d.-authorTime3.java2022/11/2158運行javadoc在命令行下執(zhí)行:2022/11/2122本章總體綱要編程規(guī)范文檔注釋程序調(diào)試2022/11/2159本章總體綱要編程規(guī)范2022/11/2123assert語句第一種格式assert布爾表達(dá)式;第二種格式assert布爾表達(dá)式:字符串;注意事項2022/11/2160assert語句第一種格式2022/11/2124作業(yè)習(xí)題10.82022/11/2161作業(yè)習(xí)題10.82022/11/2125本課件使用要求使用本課件，必須注明引用(具體見下一個幻燈片)書及課件均可能出現(xiàn)一些錯誤和缺陷，懇切希望廣大讀者特別是講授此課程的老師批評指正2022/11/2162本課件使用要求使用本課件，必須注明引用(具體見下一個幻燈片)引用聲明本課件來源于(或參考了)下面的書及其課件:雍俊海.《Java程序設(shè)計教程》.北京:清華大學(xué)出版社,2007.2022/11/2163引用聲明本課件來源于(或參考了)下面的書及其課件:2022/免責(zé)聲明請合法使用課件，其用途應(yīng)當(dāng)合法有益而且不應(yīng)對任何人造成任何傷害或損失同時請注意教材作者及出版社沒有對本課件作出任何承諾與保證2022/11/2164免責(zé)聲明請合法使用課件，其用途應(yīng)當(dāng)合法有益而且不應(yīng)對任何人造參考文獻(xiàn)本課件的參考文獻(xiàn)與下面書的參考文獻(xiàn)相同雍俊海.Java程序設(shè)計教程.北京:清華大學(xué)出版社,2007.雍俊海.Java程序設(shè)計習(xí)題集(含參考答案).北京:清華大學(xué)出版社,2006.雍俊海.Java程序設(shè)計.北京:清華大學(xué)出版社,2004