通俗介绍coding style两点建议:
模块划分
这个如果做得不好,简直不能忍。有的代码非常莫名其妙,有些东西本身不复杂,非要将其拆成好几个部分,然后做成一个一个碎散的模块,这样并不好。举个例子,比如有的代码就是一个小fifo,单独搞成了一个模块,一个小队列搞成了一个小模块。然后,信号每进出一次模块就会改变一次名字,导致阅读其代码大脑内存消耗很大,很吃力。不得不说,频繁的对同一信号进行变量名更换是非常低等的设计。
变量名
不要设计不知所云的变量名缩写。一般情况阅读代码都是半读半猜,变量名起的好对猜代码有很大的作用,一个莫名其妙的变量名会立刻让人把之前看的东西都忘了,脑子里就剩下:这是什么?而且,过了很久之后,当你不得不再看这段代码,你还是会再次感叹,这是什么?基于此,书写变量名基本坚持敲全单词,除非非常明显的后缀,比如reg,nxt,clk等。有的变量名有4~5 个单词长,可以全写,也可以使用易懂的简写。
版权所有权归卿萃科技 杭州FPGA事业部,转载请注明出处
作者:杭州卿萃科技ALIFPGA
原文地址:杭州卿萃科技FPGA极客空间 微信公众号
扫描二维码关注杭州卿萃科技FPGA极客空间