良好なコーディングスタイルは、コードの読み取り、デバッグ、修正に役立ちます。Verilogコードは構文が正しければ自由に記述できますが、乱雑なコーディングスタイルは往々にして一度きりの使い捨てになります。自分の書いたコードを振り返ったとき、信号の意味も分からず、モジュールの機能も理解できず、ロジックを一歩ずつ分析しなければならず、大量の時間と労力を費やして解読することになり、設計の進捗に深刻な影響を与えます。

他人や自分自身が「これは一体どの"おバカちゃん"が書いたコードだ!」と心から嘆かなくて済むように、以下でコーディングスタイルについて一定の提案を行います。

命名について

信号変数やモジュールなどには必ず意味のある名前を使用し、信号名はモジュール間を通過する際も変更しないようにします。これにより、コード自体が明確な説明情報を持ち、可読性が向上します。

名前の単語数が多すぎる場合は、先頭文字を大文字にするか、アンダースコア"_"で連結します。個人的には後者の方が明確で好きです。

  reg     DataToDestinationClock ;
  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は大文字と小文字を区別しますが、一般的な機能モジュールの名前、ポート、信号変数などはすべて小文字を使用し、parameterは大文字を使用し、電源やpadなどの特殊なポートは大文字を使用することをお勧めします。これはコード作成の便宜のためで、定数と変数を簡単に区別でき、大文字と小文字が異なるだけで同じ名前の信号変数の違いを考慮する必要がありません。

  parameter         DW = 8 ; //常量
  reg [DW-1 : 0]    wdata ;  //变量

レジスタ変数には通常サフィックスを付けます_r、遅延用に打ち合わせた(パイプライン)変数にはサフィックスを付けます_r1、_r2など。主に2つの大きな利点があります。1つはRTL設計時に変数のタイプに基づいてデータを操作しやすいことです。もう1つは、合成後のネットリストの信号名がしばしば変更されるため、サフィックスを付けると合成後のネットリストでRTL内の対応する信号変数を見つけやすくなることです。

  wire      dout_en ;
  reg       dout_en_r ;
  ...  //dout_en_r 的逻辑
  assign    dout_en = dout_en_r ;

その他のサフィックス:_d遅延後の信号を表すことができ、_t一時的に保存された信号を表すことができ、_nローアクティブ(負論理)の信号を表すことができ、_sslave信号を表すことができ、_mmaster信号などを表すことができます。

信号の命名にキーワードを使用しないでください。例えばin, out, x, zいずれも変数として推奨されません。

ファイル名は設計のmodule名前と一致させ、ファイル内には可能な限り1つの設計モジュールのみを含めるようにします。

コメントについて

各設計モジュールの先頭には、著作権、モジュール名、作者、日付、概要、修正履歴などの情報を含むファイル説明を必ず含める必要があります。例えば:

/**********************************************************
// Copyright 1891.06.02-2017.07.14
// Contact with willrious@sina.com
================ サンプル.v ======================
>> Author       : willrious
>> Date         : 1995.09.07
>> Description  : Welcome
>> note         : (1)To 
>>              : (2)My
>> V180121      : World.
************************************************************/

コメントはコードが表す意味を簡潔に表現する必要があります。短いコメントは1行のコードの後に追加し、長すぎるコメントは1行前に書きます。

   //输出位宽小于输入位宽,求取缩小的倍数及对应的位数
   parameter       SHRINK       = DWI/DWO ;
   reg [AWI-1:0]         ADDR_WR ; //写地址

コメントは異なるOSや異なるエディタでも正常に表示されるように、できるだけ英語で書きます。

ポート信号では、一般的なクロックとリセット信号を除き、他の信号にもコメントを付けるのが良いでしょう。

コメントの機能は非常に強力で、コメント情報を使用してタイミング図を描くことができ、さらにコメントを使用してデジタル回路の構造図を描くこともできます。

最適化について

括弧を使用してプログラムの優先順位や論理構造を明確にします。演算子の優先順位の問題による設計エラーを避けるため、括弧を多用することをお勧めします。同時に、括弧を巧みに使用すると、論理合成後の構造が最適化されることもあります。例えば:

    //多くの場合、直列の3つの加算器に合成される
    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);  

条件文はif文の代わりにcase文を使用するようにします。同じレベルの条件判断文が多すぎる場合、case文を使用して合成されたハードウェア構造は、if文よりも消費リソースが少なく、より良いタイミングを持つことが多いです。

ステートマシンを作成する際は、コードの整理性と安全性を確保するために、できるだけ3段式を使用します。

システム設計時には、モジュールを機能ごとに分割し、その後モジュールをインスタンス化する方法を採用します。何千行ものコードを1つのファイルに統合するよりも、モジュール分割はチーム設計に有利で、更新と保守が容易です。

美観について

ポート信号は1行に1つの信号とし、カンマはポート宣言の直後に置きます。完璧主義の方はカンマも揃えてください。

//非推奨
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
    );

1行のコードが長すぎる場合は、改行文字を使用せずに改行して記述します。例えば:

      assign rempty    = (rover_flag == rq2_wptr_decode[AWI]) &&
                         (raddr_ex >= rq2_wptr_decode[AWI-1:0]);

実行文の入れ子関係を明確にするために、できるだけbegin + endを使用します。beginはキーワードと同じ行に置き、endは新しい行に置きます。例えば、always文ブロックを使用する場合や、条件文の実行文が1つだけの場合はbegin + endキーワードを省略できます。ただし、構造の完全性とその後のコードのデバッグや修正を保証するために、このようなキーワードを追加することをお勧めします。

   always @(posedge dout_clk or negedge rstn) begin
      if (!rstn) begin
         dout_en_r       <= 1'b0 ;
      end
      else begin
         dout_en_r       <= rd_en_wir ;
      end
   end

できるだけタブキーとスペースを使用して、文を階層構造に合わせて整列させます。変数、キーワード、演算子の間にもスペースを空けて、論理判断を容易にします。

   generate
      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

モジュールをインスタンス化する際は、ポート信号と接続信号を分離し、それぞれを整列させます。接続信号がベクターの場合はそのビット幅を明示して、読み取りとデバッグを容易にします。

    ram   u_ram(
        .CLK_WR          (clk),
        .WR_EN           (wren), //満杯時は書き込み禁止
        .ADDR_WR         (addr),
        .D               (wdata[9:0]),
        .Q               (rdata[31:0])
        );

同じモジュールを複数インスタンス化する場合は、できるだけgenerate文を使用して、過度に長いインスタンス化コードの記述を避けます。