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