0
  • 聊天消息
  • 系統(tǒng)消息
  • 評論與回復
登錄后你可以
  • 下載海量資料
  • 學習在線課程
  • 觀看技術(shù)視頻
  • 寫文章/發(fā)帖/加入社區(qū)
會員中心
創(chuàng)作中心

完善資料讓更多小伙伴認識你,還能領(lǐng)取20積分哦,立即完善>

3天內(nèi)不再提示

從編寫代碼習慣談工程師風格

工程師人生 ? 來源:博客園 ? 作者:等你歸去來 ? 2021-01-15 10:11 ? 次閱讀

引語:代碼風格,是一個工程師長期以來養(yǎng)成的一些編寫代碼的習慣,其實并無絕對的好壞之分!但是,基本上可以這么說,一個有很好的代碼風格的人,技術(shù)水平絕不會太低;反之,一個沒有好的代碼風格的人,技術(shù)水平也不會高到哪里去,即使是他已經(jīng)有很多年的編程經(jīng)驗!因為,在業(yè)界有一個不成文的現(xiàn)象,那就是每個工程師都有一個追求技術(shù)提升,追求完美的夢!結(jié)果就是,隨著個人技術(shù)水平的提高,風格也越來越成熟,而這個風格就體現(xiàn)著其個人水平!

本文以PHP語言的某微視角,說幾個代碼風格上的事,同理可推至其他語言,其他技術(shù),甚至其他通用道理!

本文將以從面到線再到點的過程,講述一些個人心得。僅供大家娛樂參考,如有不對,請多多指教。如有雷同,不勝榮幸!

本文就以一個虛擬項目作為線索吧!

1、面:所謂面,就是面對一個項目擺在眼前,怎樣去部署大方向的問題的思路!準確的說,這里并不是真正地體現(xiàn)一個代碼風格,而是一個做事風格!

風格1:1. 我需要需求書,書上怎么寫,我就怎么做;2. 如果有一些未知的技術(shù),盡量讓需求上做一些讓步,以減少開發(fā)難度;3. 找個牛逼的人,帶著自己或其他人一起做;4. 時間是多久?

風格2:1. 我需要需求書,書上寫的東西,清楚嗎?有什么可要可不要的東西,有副作用嗎?2. 大概需要什么樣的輔助工具,在哪里可能會得到這些東西?3. 我怎樣組建自己的技術(shù)團隊?4. 時間是多久?5. 后期可能會有什么樣的擴展?

2、線:所謂線,可以理解為流水線吧。就是怎樣去完成這么一個計劃,怎樣調(diào)動生產(chǎn)?

風格1:1. 設計數(shù)據(jù)庫; 2. 選擇代碼框架;3. 編碼;

風格2:1. 設計服務架構(gòu);2. 模塊細化;3. 設計數(shù)據(jù)庫; 4. 選擇代碼框架;5. 編碼;

3、 點:所謂點,其實才這里說的真正的代碼風格,將著重說明一些。

風格1:任性,隨意而為,沒有規(guī)則!

風格2:著重講解!

3.1. 不一定非要使用現(xiàn)有成熟框架,但是一定要有MVC的概念,基本要拋棄面向過程編程方式,采用面向?qū)ο?,不任性?/p>

3.2. 結(jié)合多種設計模式進行開發(fā),如單例模式、工廠模式、抽象模式、觀察者模式等等,這些都是成熟的概念,都要盡量多用!優(yōu)雅,大氣,效率,易讀;

3.3. 類內(nèi)部變量定義以權(quán)限放第一位,變量修飾符放第二位,以重要程度分先后,如 public static function fun1(){} ;類名與文件名有某種特定程度的相同,方便查看;類名統(tǒng)一首字母大寫;私有變量或方法使用下劃線開頭以區(qū)分,如 private function _doCut($data);文件以最能體現(xiàn)其功能的單詞命名,區(qū)分類型,如 IndexController.class.php, function.inc.php;

3.4. 文件內(nèi)部使用統(tǒng)一命名方式,要么使用下劃線方式命名,如 $get_child,$bind_value,要么使用駝峰式命名,如 $getChild,$bindValue;變量名盡量使用全名不要使用簡寫,如 getCategory不要簡寫成getCat;

3.5. 多個參數(shù)之間有逗號分隔時,逗號后要留一個空格如 fun($param1, $param2);運算符兩邊均有一個空格(數(shù)組對齊除外),如 $click = 123;

3.6. 避免使用global變量,尤其是有些不是公共初始化時產(chǎn)生的變量;

3.7. 杜絕函數(shù)內(nèi)部include方法文件,因為這樣很難找到真正起作用的方法,或者說方法混亂;

3.8. 使用自動加載方式,而非include方式;

3.9. 如果一定要包含文件,盡量使用include_once,require_once 避免一個文件被引入多次從而報錯情況;

3.10. 對可能多次引用的全局變量,使用某類的靜態(tài)方法進行獲取,如 ConfigClass::get(‘main’, ‘field’); 對于數(shù)據(jù)庫一類連接,使用靜態(tài)變量,保存首次連接時打開的連接,從而多處使用DB實例時,仍然不會重復實例化,如 $db = ConfigClass::getDbInstance();

3.11. 多使用isset(), empty()等系統(tǒng)函數(shù)進行判斷空操作而非 !$var, $var == null;

3.12. 對于使用兩次以上方法,就應該去考慮提出到公用地方或者類中;

3.13. 數(shù)據(jù)查詢先確認當前索引,配合寫SQL,特別地方,一定加上注釋;

3.14. 會使用文件鎖,數(shù)據(jù)庫鎖,會使用緩存如 memcache, redis, mongodb等;

3.15. 會適當使用事務;

其實,好與不好,大家已早有定論,只是作個參考,罷了!

習慣,就好!

不要害怕今日的苦,你要相信明天,更苦!
編輯:hfy

聲明:本文內(nèi)容及配圖由入駐作者撰寫或者入駐合作網(wǎng)站授權(quán)轉(zhuǎn)載。文章觀點僅代表作者本人,不代表電子發(fā)燒友網(wǎng)立場。文章及其配圖僅供工程師學習之用,如有內(nèi)容侵權(quán)或者其他違規(guī)問題,請聯(lián)系本站處理。 舉報投訴
  • 工程師
    +關(guān)注

    關(guān)注

    59

    文章

    1571

    瀏覽量

    68553
  • PHP
    PHP
    +關(guān)注

    關(guān)注

    0

    文章

    453

    瀏覽量

    26709
收藏 人收藏

    評論

    相關(guān)推薦

    嵌入式工程師常用的開發(fā)工具有哪些?

    。 一、集成開發(fā)環(huán)境(IDE) IDE是嵌入式開發(fā)的核心工具之一。例如 Keil MDK,它支持多種微控制器架構(gòu),提供了強大的代碼編輯、編譯、調(diào)試功能。工程師可以在一個集成的環(huán)境中高效地編寫
    發(fā)表于 12-20 15:29

    讓單片機代碼性能起飛的七大技巧

    單片機的程序比軟開少一些,真正想編寫出高效的代碼,還是要積累很多年的。? ? ? ? ?? 在做研發(fā)工程師的10年里,我經(jīng)歷過幾個公司,看過很多工程師寫的
    的頭像 發(fā)表于 11-16 10:21 ?600次閱讀
    讓單片機<b class='flag-5'>代碼</b>性能起飛的七大技巧

    AIC3254的miniDSP編寫代碼編寫C5502代碼有什么區(qū)別?

    問題:AIC3254的miniDSP編寫代碼編寫C5502代碼有什么區(qū)別,執(zhí)行速度和代碼量來進行分析吧,謝謝回復
    發(fā)表于 11-06 07:22

    怎么樣提高verilog代碼編寫水平?

    ,共同進步。 歡迎加入FPGA技術(shù)微信交流群14群! 交流問題(一) Q:怎么樣提高verilog代碼編寫水平?Cpu 從事DFT工作。目前僅限于寫一些簡單模塊。自學的話如何提高verilog編寫水平
    發(fā)表于 09-25 20:05

    FPGA算法工程師、邏輯工程師、原型驗證工程師有什么區(qū)別?

    的設計和實現(xiàn)。他們使用硬件描述語言(如 Verilog 或 VHDL)來編寫代碼,構(gòu)建復雜的數(shù)字邏輯系統(tǒng)。工作包括模塊的設計、功能的實現(xiàn)、時序的優(yōu)化以及與其他硬件組件的接口設計等。 FPGA 原型驗證工程師
    發(fā)表于 09-23 18:26

    探討AI編寫代碼技術(shù),以及提高代碼質(zhì)量的關(guān)鍵:靜態(tài)代碼分析工具Perforce Helix QAC &amp; Klocwork

    令軟件開發(fā)人員夜不能寐的事情比比皆是。如今,他們最關(guān)心的問題不再是如何用自己喜歡的語言(C、C++、Erlang、Java 等)表達最新的算法,而是人工智能(AI)。 本文中,我們將介紹AI編寫代碼
    的頭像 發(fā)表于 06-05 14:10 ?417次閱讀

    扎心靈魂小拷問:有了AI編寫代碼之后,軟件工程師會被AI取代嗎?

    軟件開發(fā)者們有很多讓他們焦慮的事情。他們最擔心的不再是如何用他們最喜歡的編程語言(C、C++、Erlang、Java等)表達最新的算法。相反,這種擔憂正逐漸被人工智能(AI)所取代。 在這里,我們將探討AI編寫代碼的過程,并回答這個問題:AI會取代程序員嗎?
    的頭像 發(fā)表于 05-24 19:17 ?665次閱讀
    扎心靈魂小拷問:有了AI<b class='flag-5'>編寫</b><b class='flag-5'>代碼</b>之后,軟件<b class='flag-5'>工程師</b>會被AI取代嗎?

    嵌入式軟件工程師和硬件工程師的區(qū)別?

    、調(diào)試和測試嵌入式軟件,以確保其功能正常,性能優(yōu)良。 * 文檔編寫:包括編寫用戶手冊、維護文檔等。 * 維護和更新:對現(xiàn)有的嵌入式軟件進行維護和更新,以解決出現(xiàn)的問題和滿足新的需求。 嵌入式軟件工程師
    發(fā)表于 05-16 11:00

    嵌入式系統(tǒng)中C語言的編寫規(guī)范

    最重要的一條規(guī)則 編寫代碼時最重要的一條規(guī)則是:檢查周圍的代碼并嘗試模仿它。 作為維護人員,如果收到的補丁明顯與周圍代碼的編碼風格不同,這是
    的頭像 發(fā)表于 05-11 08:49 ?1163次閱讀

    大廠電子工程師常見面試題#電子工程師 #硬件工程師 #電路知識 #面試題

    電子工程師電路
    安泰小課堂
    發(fā)布于 :2024年04月30日 17:33:15

    為何國外工程師偏愛使用for(;;)來實現(xiàn)MCU死循環(huán)?

    一位工程師發(fā)現(xiàn),國外工程師在給demo在做死循環(huán)時用的是for(;;),而不是常用的while(1)。這僅僅是個人習慣的問題,還是有更深層次的含義?
    發(fā)表于 04-01 11:26 ?666次閱讀
    為何國外<b class='flag-5'>工程師</b>偏愛使用for(;;)來實現(xiàn)MCU死循環(huán)?

    一位硬件工程師的歷練之路:入門學習理論到... #搞笑 #硬件工程師 #電子工程師 #揚興科技

    硬件工程師揚興科技
    揚興科技
    發(fā)布于 :2024年03月13日 17:50:21

    單片機如何通過代碼控制硬件:一名工程師的分享

    今天跟大家聊聊單片機是怎樣通過代碼來操控硬件的。作為一名單片機工程師,我們平時的工作就像是給單片機編寫“指令集”,讓它按照我們的意圖去驅(qū)動各種硬件設備。
    的頭像 發(fā)表于 03-06 14:46 ?1533次閱讀
    單片機如何通過<b class='flag-5'>代碼</b>控制硬件:一名<b class='flag-5'>工程師</b>的分享