程序員:為什麼幾個月後我自己寫的代碼也看不懂了?

寫在開始的"註釋很重要","註釋很重要","註釋很重要",重要的事情說三遍。

程序員們大多都會有過這樣的經歷,就是要看別人寫的代碼。比如說公司有同事離職了,他的業務就需要有其它的小夥伴們給接下來繼續維護。這對好多程序員來說是一種折磨,邊看邊罵,這寫的是什麼東西呀。相信好多人都有這種經歷。

那麼為什麼會出現這樣一個局面呢,其實這裡面就有很多講究的地方了,如果不注意的話,不光是看不懂別人寫的代碼,即使是自己寫的代碼,幾個月後你再去瞧瞧,你也會發現,咦,看不懂了呢。那麼接下來就分析一下這種情況形成的原因及怎麼去解決它們。

程序員:為什麼幾個月後我自己寫的代碼也看不懂了?

形成這種局面的原因

1.面向過程去寫代碼

寫代碼前沒有對代碼進行設計,完全是隨心所欲去實現。對自己的要求比較低,就是“能實現功能就可以了”這種心態去寫代碼。這樣的代碼將來是十分不好維護的,別說以後讓別人來維護這個代碼了,即使幾個月後的自己也是非常困難能讀懂自己的代碼。

2.代碼沒有註釋

代碼註釋是對讀取代碼有著非常好的輔助作用,是其他人能夠快速的瞭解代碼的功能,同時對自己以後回頭來看自己的代碼也是十分有幫助的。沒有註釋的代碼就像深夜車燈壞了的汽車一樣,雖然能行駛,但是你敢快開麼?

程序員:為什麼幾個月後我自己寫的代碼也看不懂了?

3.代碼變量名稱隨意

比如什麼abc,temp這類變量,這是讓誰看的,不根據代碼的上下文誰也不知道這是啥意思,如果代碼的上下文中全是類似這樣的變量,我估計看代碼的人會瘋掉的。

4.每個方法分工不明確

一個方法中夾雜著多種功能,讓人看了之後很難說出這個方法是幹啥的,也不敢輕易去修改。

破除這種局面

不論為自己還是為別人,讓以後自己能看懂自己的代碼,還是為別人能看懂自己的代碼,讓自己不捱罵,那麼就推薦以下幾種方法來規範自己的代碼,讓別人或者是自己能夠輕輕鬆鬆看懂自己的代碼

1.實現功能前先設計好代碼

最好是面向對象的方式編程,不論是java還是Python都能很好的應用面向對象的方式進行編程,設計好文件名,類名,以及方法名,不論是文件名,還是類名,方法名都要做到見名知意,要用標準的英文去表示,需要用多個英文表示就用駝峰標識來表達。讓人看上去結構一目瞭然,代碼看上去讓人賞心悅目。

2.註釋寫的儘量詳細

每個類,每個方法都要寫明註釋, 類的註釋可以簡明寫這個類的主要功能,但是每個方法的註釋儘量要寫細了,註釋一定要覆蓋方法中所實現的所有功能,而不是隻寫其中一部分。看過系統級源碼的程序員都知道,註釋的行數是比代碼的行數還要多的。這就是優秀的習慣,我們也要去學習、掌握。

3.不要隨便定義臨時變量

儘量不要定義一些臨時的變量,如果十分必要定義時,最好是加上單行註釋,讓其他人知道你的意圖。

4.不要寫太長的方法

每個方法最好不要超過500行代碼,如果過長了,可以考慮該方法的功能點是否可以再次拆分,最好是一個方法就實現單一的一個功能,這樣的話方法的複用率也會提高的。

5.不要寫太“牛”的代碼了

有的程序員喜歡寫非常有個性的代碼,喜歡寫一些別人很難看懂的代碼,他認為這樣才能顯示出自己的“高水平”,這樣就不是高水平了,只能說代碼的可讀性太差了,我們要寫出傻瓜式代碼,也就是說讓很傻的程序員都能看懂,"傻瓜式代碼" != "低性能代碼”哈,這一點要分開。

6.中國人就別寫英文註釋了

好多國內的程序員給代碼寫註釋用英文寫,如果英文非常好的話寫英文註釋那當然是無可厚非,如果你英文不好,那麼還是勸你別寫英文註釋了,你在折磨自己也折磨別人嘛。

如果你有什麼好的看法或者觀點可以在評論區展現你的才華,互動交流,如果想進一步瞭解我,那就關注我吧。

分享 IT 技術和行業經驗,請關注-


分享到:


相關文章: