引語(yǔ):代碼風(fēng)格,是一個(gè)工程師長(zhǎng)期以來(lái)養(yǎng)成的一些編寫(xiě)代碼的習(xí)慣,其實(shí)并無(wú)絕對(duì)的好壞之分!但是,基本上可以這么說(shuō),一個(gè)有很好的代碼風(fēng)格的人,技術(shù)水平絕不會(huì)太低;反之,一個(gè)沒(méi)有好的代碼風(fēng)格的人,技術(shù)水平也不會(huì)高到哪里去,即使是他已經(jīng)有很多年的編程經(jīng)驗(yàn)!因?yàn)?,在業(yè)界有一個(gè)不成文的現(xiàn)象,那就是每個(gè)工程師都有一個(gè)追求技術(shù)提升,追求完美的夢(mèng)!結(jié)果就是,隨著個(gè)人技術(shù)水平的提高,風(fēng)格也越來(lái)越成熟,而這個(gè)風(fēng)格就體現(xiàn)著其個(gè)人水平!
本文以PHP語(yǔ)言的某微視角,說(shuō)幾個(gè)代碼風(fēng)格上的事,同理可推至其他語(yǔ)言,其他技術(shù),甚至其他通用道理!
本文將以從面到線(xiàn)再到點(diǎn)的過(guò)程,講述一些個(gè)人心得。僅供大家?jiàn)蕵?lè)參考,如有不對(duì),請(qǐng)多多指教。如有雷同,不勝榮幸!
本文就以一個(gè)虛擬項(xiàng)目作為線(xiàn)索吧!
1、面:所謂面,就是面對(duì)一個(gè)項(xiàng)目擺在眼前,怎樣去部署大方向的問(wèn)題的思路!準(zhǔn)確的說(shuō),這里并不是真正地體現(xiàn)一個(gè)代碼風(fēng)格,而是一個(gè)做事風(fēng)格!
風(fēng)格1:1. 我需要需求書(shū),書(shū)上怎么寫(xiě),我就怎么做;2. 如果有一些未知的技術(shù),盡量讓需求上做一些讓步,以減少開(kāi)發(fā)難度;3. 找個(gè)牛逼的人,帶著自己或其他人一起做;4. 時(shí)間是多久?
風(fēng)格2:1. 我需要需求書(shū),書(shū)上寫(xiě)的東西,清楚嗎?有什么可要可不要的東西,有副作用嗎?2. 大概需要什么樣的輔助工具,在哪里可能會(huì)得到這些東西?3. 我怎樣組建自己的技術(shù)團(tuán)隊(duì)?4. 時(shí)間是多久?5. 后期可能會(huì)有什么樣的擴(kuò)展?
2、線(xiàn):所謂線(xiàn),可以理解為流水線(xiàn)吧。就是怎樣去完成這么一個(gè)計(jì)劃,怎樣調(diào)動(dòng)生產(chǎn)?
風(fēng)格1:1. 設(shè)計(jì)數(shù)據(jù)庫(kù); 2. 選擇代碼框架;3. 編碼;
風(fēng)格2:1. 設(shè)計(jì)服務(wù)架構(gòu);2. 模塊細(xì)化;3. 設(shè)計(jì)數(shù)據(jù)庫(kù); 4. 選擇代碼框架;5. 編碼;
3、 點(diǎn):所謂點(diǎn),其實(shí)才這里說(shuō)的真正的代碼風(fēng)格,將著重說(shuō)明一些。
風(fēng)格1:任性,隨意而為,沒(méi)有規(guī)則!
風(fēng)格2:著重講解!
3.1. 不一定非要使用現(xiàn)有成熟框架,但是一定要有MVC的概念,基本要拋棄面向過(guò)程編程方式,采用面向?qū)ο?,不任性?/p>
3.2. 結(jié)合多種設(shè)計(jì)模式進(jìn)行開(kāi)發(fā),如單例模式、工廠模式、抽象模式、觀察者模式等等,這些都是成熟的概念,都要盡量多用!優(yōu)雅,大氣,效率,易讀;
3.3. 類(lèi)內(nèi)部變量定義以權(quán)限放第一位,變量修飾符放第二位,以重要程度分先后,如 public static function fun1(){} ;類(lèi)名與文件名有某種特定程度的相同,方便查看;類(lèi)名統(tǒng)一首字母大寫(xiě);私有變量或方法使用下劃線(xiàn)開(kāi)頭以區(qū)分,如 private function _doCut($data);文件以最能體現(xiàn)其功能的單詞命名,區(qū)分類(lèi)型,如 IndexController.class.php, function.inc.php;
3.4. 文件內(nèi)部使用統(tǒng)一命名方式,要么使用下劃線(xiàn)方式命名,如 $get_child,$bind_value,要么使用駝峰式命名,如 $getChild,$bindValue;變量名盡量使用全名不要使用簡(jiǎn)寫(xiě),如 getCategory不要簡(jiǎn)寫(xiě)成getCat;
3.5. 多個(gè)參數(shù)之間有逗號(hào)分隔時(shí),逗號(hào)后要留一個(gè)空格如 fun($param1, $param2);運(yùn)算符兩邊均有一個(gè)空格(數(shù)組對(duì)齊除外),如 $click = 123;
3.6. 避免使用global變量,尤其是有些不是公共初始化時(shí)產(chǎn)生的變量;
3.7. 杜絕函數(shù)內(nèi)部include方法文件,因?yàn)檫@樣很難找到真正起作用的方法,或者說(shuō)方法混亂;
3.8. 使用自動(dòng)加載方式,而非include方式;
3.9. 如果一定要包含文件,盡量使用include_once,require_once 避免一個(gè)文件被引入多次從而報(bào)錯(cuò)情況;
3.10. 對(duì)可能多次引用的全局變量,使用某類(lèi)的靜態(tài)方法進(jìn)行獲取,如 ConfigClass::get(‘main’, ‘field’); 對(duì)于數(shù)據(jù)庫(kù)一類(lèi)連接,使用靜態(tài)變量,保存首次連接時(shí)打開(kāi)的連接,從而多處使用DB實(shí)例時(shí),仍然不會(huì)重復(fù)實(shí)例化,如 $db = ConfigClass::getDbInstance();
3.11. 多使用isset(), empty()等系統(tǒng)函數(shù)進(jìn)行判斷空操作而非 !$var, $var == null;
3.12. 對(duì)于使用兩次以上方法,就應(yīng)該去考慮提出到公用地方或者類(lèi)中;
3.13. 數(shù)據(jù)查詢(xún)先確認(rèn)當(dāng)前索引,配合寫(xiě)SQL,特別地方,一定加上注釋?zhuān)?/p>
3.14. 會(huì)使用文件鎖,數(shù)據(jù)庫(kù)鎖,會(huì)使用緩存如 memcache, redis, mongodb等;
3.15. 會(huì)適當(dāng)使用事務(wù);
其實(shí),好與不好,大家已早有定論,只是作個(gè)參考,罷了!
習(xí)慣,就好!
不要害怕今日的苦,你要相信明天,更苦!
編輯:hfy
-
工程師
+關(guān)注
關(guān)注
59文章
1590瀏覽量
69482 -
PHP
+關(guān)注
關(guān)注
0文章
454瀏覽量
27531
發(fā)布評(píng)論請(qǐng)先 登錄


硬件工程師看了只會(huì)找個(gè)角落默默哭泣#硬件工程師 #MDD #MDD辰達(dá)半導(dǎo)體 #產(chǎn)品經(jīng)理 #軟件工程師
一技在手,醫(yī)療無(wú)憂(yōu)!零基礎(chǔ)轉(zhuǎn)行高薪醫(yī)療維修工程師

從“設(shè)計(jì)到生產(chǎn)”的蛻變:華秋DFM如何讓工程師們“輕松上陣”?
從單片機(jī)初學(xué)者邁向單片機(jī)工程師



不同時(shí)期的硬件工程師,最怕發(fā)生的事 #電子工程師 #硬件工程師 #內(nèi)容過(guò)于真實(shí) #YXC晶振 #揚(yáng)興科技
嵌入式工程師常用的開(kāi)發(fā)工具有哪些?
讓單片機(jī)代碼性能起飛的七大技巧

AIC3254的miniDSP編寫(xiě)代碼和編寫(xiě)C5502代碼有什么區(qū)別?
怎么樣提高verilog代碼編寫(xiě)水平?

評(píng)論