代码编写规范全解.doc

代码书写规范 3.1 命名规范 3.1.1 HDL代码命名总则 具有意义的命名比注释要好得多。在写代码时，命名应给予充分的重视，任何命名都应遵循简洁、明了、准确的原则，切忌模棱两可。 3.1.1.1 文件名应由字母、数字及下划线组成 命名只能由26个英文字母（a-z，A-Z）、数字（0-9）或者下划线( _ )组成。不允许使用破折号和连续的下划线。 3.1.1.2 文件名的首字符必须是字母 第一个字符只能使用字母，不能使用下划线，避免与一些工具的冲突。 3.1.1.3 用下划线分开多个单词 由多个字组成的文件名，每个字要用下划线分开。在保证一致性的情况下，提高了在修改、验证和调试中的可读性。 举例：R_ram_addr。 3.1.1.4 IO信号与信号名的区分 为了增加可读性，便于阅读代码的人理解，输入输出口与内部的寄存器、变量名要区分开，采用加前缀的方法，且统一用大写字母。如： I_sigan1 , // 表示是输入信号 I_signal2, // 表示是输入信号 O_signal3, // 表示是输出信号 reg [31:0] R_signal4; // 表示是本模块内部寄存器信号 wire [7:0] W_signal5; // 表示是本模块内部连线信号 3.1.1.5 Verilog文件名与相应的文档名一致 说明文档中所参考的V