關於“代碼規范”,“Review”和“Check list”


      關於“代碼規范”,“Review”和“Check list”,就我個人理解,這三者相輔相成。代碼規范是在編程時就該注意的,為Review減輕負擔。而要進行Review,又需要一個Check list作為支撐。在進行Review過程中,如若發現代碼中遺漏了什么規則,則又需要在自己的代碼規范和Check list中添加相應的項目。

      一.我們先從“代碼規范”說起。

      http://blog.csdn.net/kimylrong/article/details/7700311  在這篇博客中主要談到了關於JAVA編寫的三大點代碼規范,雖然略顯籠統,但就大體方向而言讓人容易掌握。

      https://www.douban.com/note/82618786/   這篇文章則更加具體的談論了JAVA編寫的代碼規范,並結合實例,一目了然。

      http://wenku.baidu.com/link?                                       url=ZEQyZjRUBBqcvJzkEalC8PdJBvW0twabaZUQPUtilnOpflFbgq31s1HmlACRFNvF5uJ_z47YNiLP2zLaKoA4elJEjJL3PfPQL2_9VHhC9Z3

      這篇文章寫得是最為詳細的,小到代碼縮進、對齊,大到模塊設計、輸入控制等等。

      看了這么多關於代碼規范的文章,說實話,自己的對於代碼規范的想法始終停留在兩點:1.格式。   2.注釋。        再仔細想想,似乎還有一點,“規則”,例如:命名規則、定義規則等等。但再仔細一想如果說“規則”,那“格式”與“注釋”也都應該屬於“規則”之中。故還是具體到“格式”,“注釋”兩點。

 

      二. 再來說說“Review”。

      我們為什么要Review?Review要做些什么?這兩點必須明確。

      Review的目的是什么?目的不明,結果也就無意義。個人覺得有以下幾個目的:

      1.在項目初期就能發現代碼中的BUG,提早解決。

      2.發現的問題可以與項目組成員共享,以免發生類似錯誤。

      3.讓項目組所有人都參與Review,利於項目、工程或代碼的修改與維護。

 

      從目的出發,Review到底要做什么就非常清楚了。

      1.根據事先定好的Check list,進行找錯,糾錯。

      2.理解項目、工程或代碼的具體功能和作用。

      3.在理解功能和作用的基礎上,進行針對性的檢查。例如:代碼完整性檢查,代碼健壯性檢查等等。

 

      三.最后來說說Check list。

      不多說,直接上文章。

      http://uedc.163.com/4308.html    Web交互設計優化的簡易check list

         http://blog.sina.com.cn/s/blog_8c78002c0100ttmw.html     這個Check list實例,說實話,雖然樣式十分粗糙,但條理還是很清晰的。

         

         接下來是我的Check list。直接借鑒http://blog.jobbole.com/83595/   此博客中的常規項。在隨后的學習生活中將繼續優化。

         

      1.代碼能夠工作么?它有沒有實現預期的功能,邏輯是否正確等。

 

      2.所有的代碼是否簡單易懂?

 

      3.代碼符合你所遵循的編程規范么?這通常包括大括號的位置,變量名和函數名,行的長度,縮進,格式和注釋。

 

      4.是否存在多余的或是重復的代碼?

 

      5.代碼是否盡可能的模塊化了?

 

      6.是否有可以被替換的全局變量?

 

      7.是否有被注釋掉的代碼?

 

      8.循環是否設置了長度和正確的終止條件?

 

      9.是否有可以被庫函數替代的代碼?

 

      10.是否有可以刪除的日志或調試代碼?

 

      如果上述內容有什么不妥之處,請老師指出。謝謝!

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM