對於2次開發的一點小心得

       抽個時間來整理一下這段時間接到YQB與MN項目的解讀心得。

        剛拿到YQB代碼的時候,說實話真的無從下手,主要我拿到的這份代碼,沒有一點文字性的東西。經過前輩們的指點,我當時做了兩件事情:

        第一、在看代碼的同時,整理出一份關於該項目的文檔。文檔的主要分幾個模塊:項目的大體結構(哪幾個功能模塊)、每個模塊的佈局以及功能、使用的什麼網絡協議等等;

        第二、在其代碼上做一些必要的註釋,比如某個方法的作用是什麼。

        看完整個代碼之後,確實達到了我想要的效果,在之後的一段時間,對於經理提出來的一些小的bug修復,我都能夠遊刃有餘的完成。

        然而,中途接了另外一個項目,大概一個月左右吧,回到之前項目的時候,竟然想要再次找到之前改過的地方都有些小困難。這個時候就真是*疼了,前面做的那些感覺至少浪費了一大半。

        所以,我想了一個小辦法,至少對於我來說是能夠解決這個問題,本質上還是註釋代碼。至少這個註釋有些不同,我這裏把這個註釋叫做“標記”。需要一個文檔配合該標記,具體是這樣操作的:

        1、我們新建一個文檔,或者是表格,需要兩個字段。一個是標記的名字,另外一個是標記的含義

        2、在代碼相應的地方將標記的名字註釋好。

        3、我這裏這個標記命名都是以“book_”開頭,後面跟具體說明。比如:解決微信分享失敗的問題,book_wechat_share_fail

        OK,其實只是個很簡單的東西,但是卻解決了我的大問題,至少我下次想要定位到某個之前處理過的地方,我可以直接全項目搜索一遍對應的標記名,那麼就能很快的定位到相應的位置。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章