- 零基礎學Java(第5版)
- 黃傳祿 常建功 陳浩
- 1234字
- 2020-06-17 18:13:08
2.4 Java程序員的編碼規(guī)則
軟件工程發(fā)展到現(xiàn)在已經(jīng)非常成熟,與此同時對于程序員編碼的規(guī)則也限定得越來越多。早年天馬行空的編程與企業(yè)的要求漸行漸遠,每個公司都會對程序員的編碼習慣進行限制,包括命名、格式等。有的可以說是相當苛刻,當然每個公司的要求也是不同的,沒必要每個要求都知道。
如果讀者進入公司,按照公司要求的編碼規(guī)范去做即可。這里是筆者搜集的一些基本要求,主要是一些常識和編碼思想,也是大家都比較認同的編碼規(guī)則。如果新入門讀者有的地方不明白也沒有太大關系,等學完后面的知識再回來看這節(jié)內(nèi)容就可以了。
(1)注釋
注釋用來提供源代碼自身沒有提供的附加信息,主要包含對代碼的總體說明、步驟說明、設計決策信息和其他一些代碼中不容易看出來的信息。
注意 注釋并不是越多越好,過多且容易過時的注釋往往會影響代碼的更新和閱讀。
(2)命名規(guī)范
命名規(guī)范提供一些有關標識符功能的信息,有助于理解代碼,使程序更易讀。
在標識符中,所有單詞的首字母大寫,被稱為駝峰標識。字段、方法以及對象的首字母小寫。例如:類名可以寫作MyFirstClass,而方法名則要寫成getName()。
如果是常量,則static final基本類型標識符中的所有字母大寫。這樣就可以標志出它們屬于編譯期的常量,如MAX_LENGTH。
Java包(Package)的包名全部小寫,首字母也不例外。例如,com.java.util。
(3)類的測試
每當創(chuàng)建一個類時,考慮在該類中寫主方法進行測試,以保證類的正確性和功能的完整性。測試代碼也可以作為如何使用類的示例來使用。
(4)類的設計
設計類時要盡量使其功能單一,只解決某些特定的問題;不要設計方法眾多且差別較大的類。
注意 設計類時要考慮該類的維護和發(fā)展,考慮代碼復用和多態(tài)。
(5)方法的設計
方法的設計與類一樣,都是盡量明確其功能,簡明扼要,功能單一。當方法過長時,盡量考慮將其分解成幾個方法。
(6)封裝
對代碼進行封裝時,出于安全方面的考慮,盡可能將方法和屬性“私有”。
(7)采用內(nèi)部類
當類和類之間關系非常緊密時,可以考慮采用內(nèi)部類來實現(xiàn),以改善編碼和維護的工作。
(8)接口編程
接口主要描述了可能完成哪些功能和方法,而類描述的是具體的實施細節(jié)。故當需要某個類作為基礎類時,盡量考慮將其變成一個接口。如果不得不使用方法或成員變量,才將其變成一個抽象類。
(9)繼承
對于繼承的使用應該謹慎,盡量采取實現(xiàn)接口的方法來達到目的。只有在必須繼承的情況下才考慮繼承。
(10)分析的順序
對于項目的分析要從宏觀到微觀,從整體到局部。首先把握項目的整體概況,掌握全局之后再考慮細節(jié)的實現(xiàn)。
(11)性能的優(yōu)化
性能的優(yōu)化是考察項目好壞的一個方面,但并不是最重要的方面。正確的方法是先讓程序運行起來,只有在確實存在性能瓶頸時才進行優(yōu)化。如果很小性能提升的代價是代碼的難于理解和維護,將得不償失。
(12)設計與編碼
對于一個項目而言,分析設計和編碼的時間比例大約是8∶2,通常會在擁有完善的設計和解決方案以后才進行編碼工作,此時的編碼工作將非常簡單。如果只是花很少的時間進行分析和設計,那么編碼工作必定困難重重,甚至延長項目時間,造成違約。
- The DevOps 2.3 Toolkit
- C++程序設計(第3版)
- 小程序?qū)崙?zhàn)視頻課:微信小程序開發(fā)全案精講
- Learning Flask Framework
- 深入淺出Prometheus:原理、應用、源碼與拓展詳解
- Java 9 Programming Blueprints
- Rust Cookbook
- 機械工程師Python編程:入門、實戰(zhàn)與進階
- Julia Cookbook
- Serverless架構
- Learning DHTMLX Suite UI
- 劍指大數(shù)據(jù):企業(yè)級數(shù)據(jù)倉庫項目實戰(zhàn)(在線教育版)
- R用戶Python學習指南:數(shù)據(jù)科學方法
- Spring+Spring MVC+MyBatis從零開始學
- Java EE企業(yè)級應用開發(fā)教程(Spring+Spring MVC+MyBatis)