命名规范：信号、模块、参数、接口的命名规则

说实话，我在刚入行那会儿，对命名这事儿真没太当回事。觉得代码能跑通就行，名字嘛，随便起一个。结果呢？有一次项目交接，我写的代码被同事吐槽了整整一个下午。从那以后，我才真正意识到——好的命名，就是最好的注释。

这一节，咱们就聊聊命名规范。我会结合自己踩过的坑，把信号、模块、参数、接口的命名规则讲清楚。你想想看，如果整个团队都用同一套规则，代码读起来得多省心。

一、为什么命名规范这么重要？

先问个问题：你见过这样的代码吗？

wire a, b, c;
reg d, e, f;
assign a = b & c;
always @(posedge clk) d <= a;

嗯，这代码功能上没问题。但三个月后你自己回来看，还能记得 a 是啥吗？更别提别人了。

我个人习惯是：命名要能自解释。看到名字，就能猜出它的功能、类型、甚至位宽。这不是矫情，这是专业素养。

二、匈牙利命名法：到底要不要用？

匈牙利命名法，说白了就是在变量名前加个前缀，标明它的类型。比如 w_data 表示 wire 类型的数据，r_cnt 表示 reg 类型的计数器。

我在项目中遇到过两种极端：

• 过度使用：每个信号都加前缀，代码看起来像密码本
• 完全不用：信号名混乱，类型全靠猜

我的建议是：适度使用，重点突出。比如：

前缀	含义	示例
w_	wire 类型	w_data_valid
r_	reg 类型	r_counter
c_	常量/参数	c_FIFO_DEPTH
i_	输入信号	i_clk
o_	输出信号	o_data
io_	双向信号	io_bus

三、模块命名：清晰、简洁、有层次

模块名，说白了就是你这个模块的身份证。我见过有人用 top、sub、module1 这种名字，嗯，我只能说：你开心就好。

我个人习惯的模块命名规则：

• 功能优先：用模块的核心功能命名，比如 uart_tx、fifo_ctrl
• 层次清晰：顶层模块用 _top 后缀，比如 chip_top
• 避免缩写过度：arb 可以，但 arbt 就过分了

// 好的例子
module uart_rx (
    input  wire       i_clk,
    input  wire       i_rst_n,
    input  wire       i_rx,
    output reg  [7:0] o_data,
    output reg        o_valid
);

// 不好的例子
module u1 (
    input  a,
    input  b,
    output c
);

四、信号命名：让名字说话

信号命名，我踩过最大的坑就是：名字太短。比如 en、sel、cnt。你想想看，一个项目几百个信号，每个都这么短，鬼知道谁是谁。

我的建议：

• 动词+名词：比如 data_valid、fifo_full、tx_busy
• 方向明确：输入用 i_，输出用 o_，内部用 w_ 或 r_
• 位宽标注：多比特信号可以加 _n 后缀，比如 data_n

// 好的信号命名
wire        w_clk_50m;
wire        w_rst_n;
wire [31:0] w_data_bus;
reg  [7:0]  r_tx_data;
reg         r_tx_busy;

// 不好的信号命名
wire clk;
wire rst;
wire [31:0] dbus;
reg  [7:0]  td;
reg         tb;

五、参数命名：大写+下划线

参数，说白了就是模块的"配置项"。我见过有人用 depth、width 这种小写命名，嗯，也不是不行，但容易和信号混淆。

行业惯例是：全大写 + 下划线分隔。比如：

parameter  C_FIFO_DEPTH   = 16;
parameter  C_DATA_WIDTH   = 8;
parameter  C_ADDR_WIDTH   = 4;

为什么用 C_ 前缀？因为一眼就能看出它是参数，不是信号。我在项目中遇到过有人把参数当信号用，结果综合时报了一堆 warning。嗯，从那以后我就坚持加前缀了。

六、接口命名：统一、规范、易扩展

接口命名，说白了就是模块之间的"握手协议"。我见过最乱的接口命名：同一个模块，有的信号用 valid，有的用 vld，还有的用 en。你想想看，这得多乱。

我的建议：

• 统一后缀：比如 _valid、_ready、_data
• 接口分组：用前缀区分不同接口，比如 axi_、apb_、i2c_
• 方向明确：输入输出用 i_、o_ 区分

// AXI 接口命名示例
input  wire        i_axi_awvalid;
input  wire [31:0] i_axi_awaddr;
input  wire        i_axi_wvalid;
input  wire [31:0] i_axi_wdata;
output wire        o_axi_bvalid;
output wire [1:0]  o_axi_bresp;

七、避坑指南：我曾经踩过的坑

嗯，这里分享几个我亲身经历过的坑：

• 大小写混用：比如 DataValid 和 data_valid 混着用。结果仿真时两个信号对不上，查了半天才发现是大小写问题。
• 缩写不一致：同一个模块里，cnt 和 counter 混用。你想想看，这得多难受。
• 名字太长：比如 data_from_uart_to_fifo_valid。嗯，这名字是够清晰，但写起来太累。建议控制在20个字符以内。

八、知识体系图

下面这张图，帮你理清命名规范的核心逻辑：

这张图把命名规范分成了四大块：模块、信号、参数、接口。每个分支下面，都有对应的核心原则。你写代码时，对着这张图检查一遍，基本就不会出大问题。

可可精品资料库