編碼風格中的兩點總結

編碼風格中的兩點總結


通俗介紹coding style兩點建議:

模塊劃分

這個如果做得不好,簡直不能忍。有的代碼非常莫名其妙,有些東西本身不復雜,非要將其拆成好幾個部分,然後做成一個一個碎散的模塊,這樣並不好。舉個例子,比如有的代碼就是一個小fifo,單獨搞成了一個模塊,一個小隊列搞成了一個小模塊。然後,信號每進出一次模塊就會改變一次名字,導致閱讀其代碼大腦內存消耗很大,很吃力。不得不說,頻繁的對同一信號進行變量名更換是非常低等的設計。

編碼風格中的兩點總結

變量名

不要設計不知所云的變量名縮寫。一般情況閱讀代碼都是半讀半猜,變量名起的好對猜代碼有很大的作用,一個莫名其妙的變量名會立刻讓人把之前看的東西都忘了,腦子裡就剩下:這是什麼?而且,過了很久之後,當你不得不再看這段代碼,你還是會再次感嘆,這是什麼?基於此,書寫變量名基本堅持敲全單詞,除非非常明顯的後綴,比如reg,nxt,clk等。有的變量名有4~5 個單詞長,可以全寫,也可以使用易懂的簡寫。

編碼風格中的兩點總結

原文地址:卿萃科技FPGA極客空間 微信公眾號



分享到:


相關文章: