資源描述:
《java 語(yǔ)言編碼規(guī)范》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。
1、版本1.0Java語(yǔ)言編碼規(guī)范文檔編號(hào)密級(jí)保密Java語(yǔ)言編碼規(guī)范Version:1.0撰寫人:完成日期:文檔使用部門:■主管領(lǐng)導(dǎo)■項(xiàng)目組□客戶(市場(chǎng))□維護(hù)人員□用戶評(píng)審負(fù)責(zé)人:評(píng)審日期:湖北省海德訊科技有限公司<版權(quán)所有不得復(fù)制>版權(quán)所有?湖北海德訊科技有限公司第21頁(yè)/共21頁(yè)版本1.0Java語(yǔ)言編碼規(guī)范變更記錄版本號(hào)修改原因/內(nèi)容修改人審核/批準(zhǔn)人修改時(shí)間版權(quán)所有?湖北海德訊科技有限公司第21頁(yè)/共21頁(yè)版本1.0Java語(yǔ)言編碼規(guī)范目錄1介紹(Introduction)51.1為什么要有編碼規(guī)范(WhyHaveCodeCo
2、nventions)51.2版權(quán)聲明(Acknowledgments)52文件名(FileNames)52.1文件后綴(FileSuffixes)52.2常用文件名(CommonFileNames)53文件組織(FileOrganization)53.1Java源文件(JavaSourceFiles)53.1.1開頭注釋(BeginningComments)63.1.2包和引入語(yǔ)句(PackageandImportStatements)63.1.3類和接口聲明(ClassandInterfaceDeclarations)64縮進(jìn)排版(
3、Indentation)74.1行長(zhǎng)度(LineLength)74.2換行(WrappingLines)75注釋(Comments)85.1實(shí)現(xiàn)注釋的格式(ImplementationCommentFormats)95.1.1塊注釋(BlockComments)95.1.2單行注釋(Single-LineComments)105.1.3尾端注釋(TrailingComments)105.1.4行末注釋(End-Of-LineComments)105.2文檔注釋(DocumentationComments)116聲明(Declarati
4、ons)116.1每行聲明變量的數(shù)量(NumberPerLine)116.2初始化(Initialization)126.3布局(Placement)126.4類和接口的聲明(ClassandInterfaceDeclarations)127語(yǔ)句(Statements)137.1簡(jiǎn)單語(yǔ)句(SimpleStatements)137.2復(fù)合語(yǔ)句(CompoundStatements)137.3回語(yǔ)句(returnStatements)137.4if,if-else,ifelse-ifelse語(yǔ)句(if,if-else,ifelse-ife
5、lseStatements)137.5for語(yǔ)句(forStatements)147.6while語(yǔ)句(whileStatements)147.7do-while語(yǔ)句(do-whileStatements)15版權(quán)所有?湖北海德訊科技有限公司第21頁(yè)/共21頁(yè)版本1.0Java語(yǔ)言編碼規(guī)范7.8switch語(yǔ)句(switchStatements)157.9try-catch語(yǔ)句(try-catchStatements)158空白(WhiteSpace)168.1空行(BlankLines)168.2空格(BlankSpaces)169
6、命名規(guī)范(NamingConventions)1710編程慣例(ProgrammingPractices)1810.1提供對(duì)實(shí)例以及類變量的訪問(wèn)控制(ProvidingAccesstoInstanceandClassVariables)1810.2引用類變量和類方法(ReferringtoClassVariablesandMethods)1810.3常量(Constants)1810.4變量賦值(VariableAssignments)1810.5其它慣例(MiscellaneousPractices)1910.5.1圓括號(hào)(Pare
7、ntheses)1910.5.2返回值(ReturningValues)1910.5.3條件運(yùn)算符"?"前的表達(dá)式(Expressionsbefore'?'intheConditionalOperator)1910.5.4特殊注釋(SpecialComments)19版權(quán)所有?湖北海德訊科技有限公司第21頁(yè)/共21頁(yè)版本1.0Java語(yǔ)言編碼規(guī)范1介紹(Introduction)1.1為什么要有編碼規(guī)范(WhyHaveCodeConventions)編碼規(guī)范對(duì)于程序員而言尤為重要,有以下幾個(gè)原因:-一個(gè)軟件的生命周期中,80%的花費(fèi)在
8、于維護(hù)-幾乎沒(méi)有任何一個(gè)軟件,在其整個(gè)生命周期中,均由最初的開發(fā)人員來(lái)維護(hù)-編碼規(guī)范可以改善軟件的可讀性,可以讓程序員盡快而徹底地理解新的代碼-如果你將源碼作為產(chǎn)品發(fā)布,就需要確任它是否被很好的打包并且清晰無(wú)誤,一如你已