Java編程規(guī)范手冊

1、如有你有幫助，請購買下載，謝謝! 1頁 網(wǎng)道 Java 編程規(guī)范 一、 目的： 本規(guī)范立足于所收集到的各種 Java編碼標(biāo)準(zhǔn)、規(guī)范、慣例以及指導(dǎo)性原則，根據(jù)本公司的具體情況進(jìn)行調(diào)整后制定而成，其目的是便于軟件代碼易 于理解、維護(hù)以及重用。更為重要的事，遵循這些標(biāo)準(zhǔn)可以顯著地提高軟件生產(chǎn)率。 記?。壕幋a是具有集體性質(zhì)的，其易讀性、易維護(hù)性是編碼優(yōu)良的重要評判標(biāo)準(zhǔn)。 二、 原則 1. 盡量添加注釋。 2. 為人編碼，而不是為電腦編碼。 3. 先做設(shè)計，然后編碼。 4. 保持代碼簡單。 5. 從小到大編制。切忌一上手就編制大規(guī)模代碼。 三、 基本規(guī)范 1注釋 在Java中，存在三種注釋，分別為： 文

2、檔注釋：/* . */; 多行注釋：/* . */; 單行注釋：/。 這三種注釋將用于不同的位置。 1.1原則 盡可能進(jìn)行代碼注釋。 力求注釋簡潔、清楚、易懂。 先寫注釋，再寫代碼 除了注釋代碼功能外， 更為重要的是注釋出為什么要這樣做，便于別人知道你寫這段代碼的目的 。 1.2注釋規(guī)范 如有你有幫助，請購買下載，謝謝! 2頁 注釋類型 用途 例子 備注 如有你有幫助，請購買下載，謝謝! 3頁 注釋類型 用途 例子 備注 文檔注釋 ( . */ ) 1. 類(Class) 2. 接口( In terface) 3. 成員函數(shù)(Member Function ) 4. 屬性(Attribute,

3、 Field ) 的聲明前面。 /* Customer -A customer is any person or organization that we sell services and products to. author S.W. Ambler */ 由于Javadoc能文檔注釋中的 某些特定元素，故文檔注釋通 常用于書寫項目文檔。 多行注釋 (/* . */) 注釋掉暫時不使用的代碼。 /* This code was comme nted out by J.T. Kirk on Dec 9, 1997 because it was replaced by the precedin

4、g code. Delete it after two years if it is still not applicable. .(the source code ) */ 表明這段源代碼暫時不使用。 可能在以后會改變主意使用 它。 必須說明原因。 單行注釋 (/) 用于成員函數(shù)中說明： 1. 程序邏輯 2. 代碼片斷 3. 臨時變量聲明等 / Apply a 5% discou nt to all in voices / over $1000 as defi ned by the Sarek / gen erosity campaig n started in / Feb. of 1995

5、. 建議采用單行注釋來進(jìn)行代碼 中的說明性行為。 1.3注釋的內(nèi)容 名稱 注釋內(nèi)容 Javadoc 參數(shù) 參數(shù) Argume nts/Parameters 參數(shù)類型 用途 使用的約束或者前提條件 盡量給出一個示例 如有你有幫助，請購買下載，謝謝! 4頁 名稱 注釋內(nèi)容 Javadoe 參數(shù) 屬性 Fields/Attributes 屬性描述 所有可能的取值或取值范圍 示例 并發(fā)中可能存在的冋題 可見性設(shè)置。通常屬性都設(shè)置為“私有”類型，如果設(shè)置不一 樣，請給出原因。 see ClassName see ClassName#memberF un etio nN ame 成員函數(shù)（外部） Member Fun cti ons 功能、用途以及編寫該成員函數(shù)的原因 輸入的參數(shù) 返回值 該函數(shù)拋出的“例外”以及拋出的條件 已知的缺陷 可見性設(shè)置 代碼更改歷史 示例（如何調(diào)用該成員函數(shù)） 可能的約束和前提條件 并發(fā)性策略 param n ame deseripti on retur n deseripti on exeepti on n ame deseripti on depreeated si nee see ClassName see ClassName#memberF un etio nN ame 成員函數(shù)（內(nèi)部） Member Fun cti ons 注釋局部變量 注釋復(fù)