guidancejava編程標準-資料下載頁
2025-05-20 19:41本頁面
【導讀】當你違背一個標準時，將其注釋出來。前可能/必須出現(xiàn)的任何條件。除了以下幾個特例之外，命名時應(yīng)始終采用完整的英文描述符。名、接口名以及任何非初始單詞的第一個字母要大寫。采用適用于該領(lǐng)域的術(shù)語。盡量少用縮寫，但如果用了，要明智地使用。避免使用類似的名字，或者僅僅是大小寫不同的名字。之前加上a或an前綴。重要的是選擇一種并堅持用。所有的布爾型獲取函數(shù)必須用單詞is做前綴。將字段名賦給它即可。構(gòu)造函數(shù)使用類名Customer(),異常通常采用字母e表示異常。全部采用大寫字母，單詞之間用下劃線分隔。地提高了靈活性?；蛘遝r，但這不是必需的。要讓一個局部變量叫firstName。循環(huán)計數(shù)器通常采用字母i，j，k或者counter都可以接受。Inter域名反轉(zhuǎn)并接上包名。盡可能采用一個生動的動詞，第一個字母小寫。避免使用裝飾物，也就是說，不要使用象小旗子那樣的注釋。下面的圖表說明Java注釋的三種類型，并給出使用建議。聲明的前面注釋它們。
【正文】 成員函數(shù)注釋 成員函數(shù)做什么以及它為什么做這個 哪些參數(shù)必須傳遞給一個成員函數(shù) 成員函數(shù)返回什么 已知的問題 任何由某個成員函數(shù)拋出的異常 可見性決策 成員函數(shù)是如何改變對象的 包含任何修改代碼的歷史 如何在適當情況下調(diào)用成員函數(shù)的例子 適用的前提條件和 后置條件 成員函數(shù)內(nèi)部注釋 控制結(jié)構(gòu) 代碼做了些什么以及為什么這樣做 局部變量 Java 編程標準 版本 6 難或復雜的代碼 處理順序 包 包的基本原理 包中的類 3 Java 程序設(shè)計約定 （一般） 有許多的有關(guān) Java 代碼可維護性和可改進性的重要約定和標準。 % 的時間里，面向他人，面向你的開發(fā)同事編程要比面向機器編程重要得多。使你的代碼為別人所理解是最重要的。 約定目標 約定 存取成員函數(shù) 考慮對數(shù)據(jù)庫中的字段使用滯后初始化 使用存取函數(shù)獲得和修改所有字段 對常量采用存取函數(shù) 對于集合，加入成員函數(shù)來插入和刪除項 一旦可能，將存取函數(shù)置為被保護類型，不是公共類型 字段 字段永遠為私有類型 不要直接訪問字段，應(yīng)使用存取成員函數(shù) 不要使用靜態(tài)常量字段（常 量），應(yīng)使用存取成員函數(shù) 不要隱藏名字 一定要初始化靜態(tài)字段 類 最小化公共和保護接口 在開始寫代碼之前定義一個類的公共接口 按以下順序聲明一個類的字段和成員函數(shù)： ? 構(gòu)造函數(shù) Java 編程標準 版本 7 ? finalize() ? 公共成員函數(shù) ? 被保護成員函數(shù) ? 私有成員函數(shù) ? 私有字段 局部變量 不要隱藏名字 一行代碼只聲明一個局部變量 用一個行內(nèi)注釋說明局部變量 在使用局部變量之前聲明它 僅將局部變量用于一件事 成員函數(shù) 給代碼加上注釋 給代碼分段 使用空白，控制結(jié)構(gòu)之前用一個空行，成員函數(shù)之前用兩個空行 一個成員 函數(shù)應(yīng)能在 30 秒內(nèi)讓人理解 寫短小單獨的命令行 盡量限制成員函數(shù)的可見性 說明操作的順序
公司管理相關(guān)推薦
鄂ICP備17016276號-1