Хороший стиль кодирования помогает читать код, отлаживать его и изменять. Хотя код Verilog можно писать произвольно, если синтаксис корректен, небрежный стиль кодирования часто приводит к тому, что код становится одноразовым. Иногда, оглядываясь на собственный код, вы не можете ни увидеть смысл сигналов, ни понять функциональность модулей, и приходится анализировать логику шаг за шагом. На его переваривание уходит много времени и сил, что серьёзно влияет на прогресс проектирования.
Чтобы другие или мы сами не воскликнули искренне: «Какой маленький глупыш написал этот чёртов код!» Ниже приведены некоторые рекомендации по стилю кодирования.
Об именовании
Переменные сигналов, модули и т. д. должны использовать осмысленные имена, а имена сигналов должны оставаться неизменными при передаче между модулями, чтобы сам код нёс ясную описательную информацию и обладал повышенной читаемостью.
Когда имя содержит слишком много слов, их можно объединять с помощью заглавных первых букв или символов подчёркивания «_». Лично я предпочитаю последний вариант, потому что он нагляднее.
reg data_to_destination_clock ; // Рекомендуется
Рекомендуется использовать сокращения слов для именования сигналов и понимать, что следует сохранить, а что отбросить, чтобы избежать слишком длинных имён сигналов. Например, clock сокращается до clk, destination — до dest, source — до src и т. д.
reg data_to_destination_clock ; reg des_data ; // РекомендуетсяУмело используйте цифры для обозначения английских слов. Например, 2 обозначает «to», а 4 обозначает «for», что позволяет сэкономить немного места в коде.
reg clk_for_test, sig_uart_to_spi ; reg clk4test, sig_uart2spi ; //推荐
Хотя Verilog чувствителен к регистру, рекомендуется использовать нижний регистр для названий обычных функциональных модулей, портов, сигнальных переменных и т. д., верхний регистр для параметров и верхний регистр для некоторых специальных портов, таких как power и pad. Это делается просто для удобства написания кода, чтобы было легко отличать константы от переменных и избегать различий между сигнальными переменными, которые имеют одинаковые имена, но разный регистр.
parameter DW = 8 ; //常量 reg [DW-1 : 0] wdata ; //变量
К регистровым переменным обычно добавляют суффикс_r, к переменным, задержанным на тактовые циклы, добавляют суффикс_r1、_r2и т. д. Есть два основных преимущества. Во-первых, при RTL-проектировании можно легко оперировать данными в соответствии с типом переменной. Во-вторых, имена сигналов в постсинтезированном списке соединений часто меняются; добавление суффиксов позволяет легко находить соответствующие сигнальные переменные в постсинтезированном списке соединений, совпадающие с теми, что в RTL.
wire dout_en ; reg dout_en_r ; ... //dout_en_r 的逻辑 assign dout_en = dout_en_r ;
Другие суффиксы:_dмогут обозначать задержанный сигнал,_tмогут обозначать временно сохранённый сигнал,_nмогут обозначать сигнал с активным низким уровнем,_sмогут обозначать ведомый信号,_mМогут обозначать ведущий信号 и т. д.
Избегайте использования ключевых слов для именования сигналов, напримерin, out, x, zне рекомендуются в качестве переменных.
Имена файлов должны оставаться согласованными с именемmoduleпроекта, и старайтесь включать только один проектный модуль в файл.
О комментариях
Каждый проектный модуль должен начинаться с описательной информации о файле, включая информацию об авторских правах, имя модуля, автора, дату, краткое описание, историю изменений и т. д. Например:
/********************************************************** // Copyright 1891.06.02-2017.07.14 // Contact with willrious@sina.com ================ example.v ====================== >> Author : willrious >> Date : 1995.09.07 >> Description : Welcome >> note : (1)To >> : (2)My >> V180121 : World. ************************************************************/
Комментарии должны кратко выражать смысл, описанный кодом. Короткие комментарии добавляются после одной строки кода, а длинные комментарии следует писать на строку выше.
//输出位宽小于输入位宽,求取缩小的倍数及对应的位数 parameter SHRINK = DWI/DWO ; reg [AWI-1:0] ADDR_WR ; //写地址
Комментарии следует по возможности писать на английском языке, чтобы обеспечить их корректное отображение в разных операционных системах и редакторах.
Среди портовых сигналов, за исключением общих сигналов тактирования и сброса, лучше также комментировать и другие сигналы.
Комментарии — очень мощный инструмент. С помощью информации в комментариях можно рисовать временные диаграммы и даже использовать комментарии для построения структурных схем цифровых устройств.


Об оптимизации
Используйте скобки для определения приоритета или логической структуры программы. Чтобы избежать ошибок проектирования, вызванных проблемами приоритета операторов, рекомендуется часто использовать скобки. В то же время умелое использование скобок иногда позволяет оптимизировать структуру после логического синтеза. Например:
assign F = A + B + C + D ;
// часто синтезируется в 2 параллельных сумматора и 1 каскадный сумматор, с более мягкими временными ограничениями
assign F = (A + B) + (C + D) ;
// Не рекомендуется
assign flag = cnt == 4'd2 && mode == 2'b01;
// Рекомендуется
assign flag = (cnt == 4'd2) && (mode == 2'b01);
Для условных операторов старайтесь использовать операторы case вместо операторов if. Когда на одном уровне слишком много условных проверок, аппаратная структура, синтезируемая из операторов case, часто потребляет меньше ресурсов и имеет лучшие временные характеристики, чем структура из операторов if.
При написании конечных автоматов старайтесь использовать 3-сегментный стиль, чтобы код был аккуратным и безопасным.
При проектировании системы старайтесь применять метод разделения модулей по функциям с последующим созданием экземпляров модулей. По сравнению с объединением тысяч строк кода в одном файле разделение на модули полезно для командной разработки и упрощает обновление и сопровождение.
Об аккуратности
Размещайте каждый портовый сигнал на отдельной строке, при этом запятая должна стоять сразу после объявления порта. Если у вас ОКР, пожалуйста, также выравнивайте запятые.
module even_divisor (input rstn, clk, output clk_div2, clk_div4, clk_div10) ;
// Рекомендуется
module even_divisor (
input rstn ,
input clk ,
output clk_div2 ,
output clk_div4 ,
output clk_div10
);
Когда строка кода слишком длинная, попробуйте перенести её на новую строку без использования символа продолжения строки, например:
assign rempty = (rover_flag == rq2_wptr_decode[AWI]) &&
(raddr_ex >= rq2_wptr_decode[AWI-1:0]);
Постарайтесь использовать begin + end, чтобы обеспечить каскадную связь между исполняемыми операторами. begin должен находиться на той же строке, что и ключевое слово, а end — на новой строке. Например, при использовании блока always или когда условный оператор содержит только один исполняемый оператор, ключевые слова begin + end можно опустить. Однако для обеспечения структурной целостности и облегчения будущей отладки и модификации рекомендуется добавлять такие ключевые слова.
if (!rstn) begin
dout_en_r <= 1'b0 ;
end
else begin
dout_en_r <= rd_en_wir ;
end
end
Старайтесь использовать клавишу Tab и пробелы, чтобы операторы выравнивались в соответствии с иерархической структурой. Также должны быть пробелы между переменными, ключевыми словами и операторами для облегчения логического анализа.
if (DWO >= DWI) begin
reg [DWI-1:0] mem [(1<<AWI)-1 : 0] ;
always @(posedge CLK_WR) begin
if (WR_EN) begin
mem[ADDR_WR] <= D ;
end
end
end
endgenerate
При инстанцировании модулей старайтесь отделять портовые сигналы от сигналов соединений и соответственно выравнивать их. Если сигнал соединения является вектором, указывайте его разрядность для удобства чтения и отладки.
.CLK_WR (clk),
.WR_EN (wren), // Не записывать при заполнении
.ADDR_WR (addr),
.D (wdata[9:0]),
.Q (rdata[31:0])
);
При инстанцировании нескольких одинаковых модулей старайтесь использовать операторы generate, чтобы избежать слишком длинных описаний кода инстанцирования.