SystemVerilog 代码风格指南_uvm编码风格推荐-优快云博客

SystemVerilog 代码风格指南

前言

代码被阅读的频率远远超过编写的频率。在团队中保持一致的编码风格能够显著提升代码的可读性，这是节省工程时间最有效（也是最简单）的方法之一。

在众多编程语言中，Python 可以说是最优雅的。阅读他人编写的 Python 代码非常轻松，即使是复杂的代码逻辑也不会让人望而却步。更重要的是，初学者编写的代码与核心开发者的代码在风格上高度一致。这主要归功于 PEP8 这一 Python 代码风格指南，整个社区对这份文档的采纳程度令人惊叹。

本风格指南借鉴了 PEP8 的成功经验和部分结构，同时结合了 UVM 库的最佳实践，避免重复造轮子。

PEP8 核心理念

风格指南的本质在于一致性。遵循本指南的一致性很重要，项目内部的一致性更重要，单个模块或功能内的一致性是最重要的。

但要知道何时打破常规——有时风格指南的建议并不适用。遇到疑惑时，请运用最佳判断。

代码布局规范

缩进规则

基本原则： 每个缩进级别使用 4 个空格。

✅ 推荐写法：

// 参数换行时，第二行从函数名下方开始
foo = long_function_name(
        var_one, var_two, var_three,
        var_four);

// 或者与第一个参数对齐（4空格缩进可选）
foo = long_function_name(var_one, var_two,
                        var_three, var_four);

// 函数声明中增加额外缩进，区分函数体
function void long_function_name(var_one, var_two,
        var_three, var_four);
    int x;
    // ...函数体...
endfunction: long_function_name

// 条件表达式换行时增加缩进
if (expr_one && expr_two &&
        expr_three) begin
    do_something();
end

❌ 不推荐写法：

// 第二行参数位置不当
foo = long_function_name(var_one, var_two,
    var_three, var_four);

// 函数声明缩进不清晰，容易与函数体混淆
function void long_function_name(var_one, var_two,
    var_three, var_four);
    int x;
    // ...
endfunction: long_function_name

制表符与空格的选择

推荐使用空格进行缩进。 制表符仅在与已有制表符缩进的代码保持兼容时使用。

编辑器配置示例：

Vi/Vim 配置：

" 将以下内容添加到 ~/.vimrc
set tabstop=4
set shiftwidth=4
set expandtab

Emacs 配置：

; 将以下内容添加到 ~/.emacs
(setq-default indent-tabs-mode nil)
(setq-default tab-width 4)
(setq indent-line-function 'insert-tab)

最大行长度限制

建议将所有行（包括注释）限制为最多 100 个字符。

传统建议是 80 个字符，但考虑到 UVM 的长宏定义特点：

`uvm_object_utils
`uvm_info(get_name(), "detailed message here", UVM_MEDIUM)

在这些声明中，仅宏和函数名就占用了约 30 个字符。如果严格遵循 80 字符限制，会频繁遇到换行困扰。因此，100 字符的限制更为实用和合理。

重要提醒： 确保换行时进行适当的缩进对齐。

begin & end 语句块

begin 与它所属的块语句在同一行
end 独占一行

✅ 推荐写法：

always_ff @(posedge clk) begin
    // 逻辑代码
end

if (big_endian == 1) begin
    m_bits[count+i] = value[size-1-i];
end
else begin
    m_bits[count+i] = value[i];
end

for (int i = 0; i < size; i++) begin
    if (big_endian == 1) begin
        m_bits[count+i