代碼產生原則

來源:互聯網
上載者:User

1.        對手寫代碼給予合適的尊重

儘管代碼產生可以免去許多重複的工作,提高開發效率,但是你必須知道無論你的產生器有多麼強大,多麼靈活,都有很多特殊情況存在,這些可能都在你的代碼產生器可歸納的範圍之外。所以,雖然你使用了代碼產生器,但是手寫代碼仍然是必需的。

2.        應當首先考慮手寫代碼。

即使有必要使用代碼產生,也要在你確定你瞭解你的架構的時候再開始使用它。

3.        控制你的代碼。

一個好的原始程式碼控制系統是代碼產生項目成功的必須的。如果你的產生器操作了已經包含了手寫代碼的檔案,你就更需要一個版本管理系統來保障你的工作。

4.        對於實現語言作謹慎的考慮。

用來實現產生器的工具不同於實現應用程式的工具。產生器的一個問題就是它嘗試去解決那些應用程式所要解決的許多完全不同的問題。基於這一點,你應當認把產生器作為一個獨立的項目來真的選擇你的工具。

5.        將產生器整合到你的開發過程中。

產生器是工程師們使用的工具,所以,它應當合理的,完整的結合到開發過程中。可以使它整合到IDE工具中,或者build過程中。

6.        包含警告。

產生器產生的程式碼中應當對那些不應被改動的地方作出警告,以防止被手工改動。如果被手工改動,那麼產生的程式碼的版本就無法保證一致。同時有可能使重要的地方出現不可預期的行為。

7.        使產生器更友好。

產生器是給程式員使用的工具,但是這並不意味著它就可以很粗糙。產生器應當告訴工程師他能夠作什麼,正在作什麼,它產生了哪些檔案。產生器應當是易用的,介面友好的。

8.        包含文檔。

好的文檔是產生器的一個賣點。你的文檔應當完整,清晰,但是不要過多。而且要對關鍵的地方作特殊的說明,比如產生器能作什麼,如何安裝,怎樣運行等。

9.        要記住並不是所有的人都會接受代碼產生。

給你的同僚們看文檔,培訓,一個接一個的會議,這些對於你的產生器的成功推廣是很危險的。人們對新事物總是充滿懷疑,你需要讓他們認識到產生器會給他們帶來怎樣的好處。

10.     認真維護產生器。

除非產生器只是一個臨時的方案,否則在很長時間內都要認真的進行維護,產生器控制著大量的代碼,維護產生器和維護代碼具有同樣的意義,你應當安排專門的時間和金錢來維護、升級它。

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.