FPGA研发之道(14)写在coding之前的铁律

写在coding之前的那些铁律

 (1)注释： 好的代码首先必须要有注释，注释至少包括文件注释，端口注释，功能语句注释。

     文件注释：文件注释就是一个说明文：这通常在文件的头部注释，用于描述代码为那个工程中，由谁写的，日期是多少，功能描述，有哪些子功能，及版本修改的标示。这样不论是谁，一目了然。即使不写文档，也能知道大概。

     接口描述：module的接口信号中，接口注释描述模块外部接口，例如AHB接口，和SRAM接口等等。这样读代码的人即可能够判断即模块将AHB接口信号线转换成SRAM接口信号。

     功能语句注释： 内部关键逻辑，状态机某状态，读过程、写过程。

    注释的重要性，毋庸置疑，好的注释，能够提高代码的可读性，可维护性等等。总之，养成注释的好习惯，代价不大，但是收益很大。

（2）语句：

开始写代码是，在FPGA设计中，特别是在可综合的模块实现中，verilog的语句是很固定的。在FPGA的设计中，不外乎时序逻辑和组合逻辑，除此之外，别无他法。对于开始功能编码来说，只需知道组合逻辑信号即可生效，时序逻辑在时钟的下一拍起效就够了。

下面是编码的实例。

组合逻辑：两种组合逻辑的描述，其功能是一致的。