Ein guter Codierungsstil hilft beim Lesen, Debuggen und Ändern von Code. Obwohl Verilog-Code beliebig geschrieben werden kann, solange die Syntax korrekt ist, ist ein schlampiger Codierungsstil oft ein einmaliges Unterfangen. Manchmal, wenn man auf seinen eigenen Code zurückblickt, kann man weder die Bedeutung der Signale erkennen noch die Funktionalität der Module verstehen, und muss die Logik Schritt für Schritt analysieren. Das kostet viel Zeit und Energie zum Verdauen und beeinträchtigt den Designfortschritt ernsthaft.

Um zu verhindern, dass andere oder wir selbst aufrichtig ausrufen: "Welches kleine dumme Baby hat diesen verdammten Code geschrieben!" Im Folgenden finden Sie einige Vorschläge zum Codierungsstil.

Über die Benennung

Signalvariablen, Module usw. müssen aussagekräftige Namen verwenden, und Signalnamen sollten beim Übergeben zwischen Modulen unverändert bleiben, damit der Code selbst klare beschreibende Informationen und eine verbesserte Lesbarkeit aufweist.

Wenn ein Name zu viele Wörter enthält, können Sie sie mit großen Anfangsbuchstaben oder Unterstrichen "_" verketten. Ich persönlich bevorzuge Letzteres, weil es klarer ist.

  reg     DataToDestinationClock ;
  reg     data_to_destination_clock ; // Empfohlen

Es wird empfohlen, Wortabkürzungen zur Benennung von Signalen zu verwenden und zu wissen, was beibehalten oder weggelassen werden soll, um übermäßig lange Signalnamen zu vermeiden. Beispielsweise wird clock als clk abgekürzt, destination als dest, source als src usw.

reg data_to_destination_clock ; reg des_data ; // Empfohlen

Verwenden Sie geschickt Zahlen, um englische Buchstaben darzustellen. Zum Beispiel steht 2 für "to" und 4 für "for", was ein winziges bisschen Codeplatz sparen kann.

  reg     clk_for_test, sig_uart_to_spi ;
  reg     clk4test, sig_uart2spi ; //推荐

Obwohl bei Verilog zwischen Groß- und Kleinschreibung unterschieden wird, wird empfohlen, für allgemeine funktionale Modulnamen, Ports, Signalvariablen usw. durchgängig Kleinbuchstaben zu verwenden, für Parameter Großbuchstaben und für einige spezielle Ports wie Power und Pad ebenfalls Großbuchstaben. Dies dient nur der Bequemlichkeit beim Codieren, erleichtert die Unterscheidung von Konstanten und Variablen und vermeidet Verwechslungen zwischen Signalvariablen mit gleichem Namen, aber unterschiedlicher Groß-/Kleinschreibung.

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

Registervariablen erhalten im Allgemeinen ein Suffix_r, durch Taktzyklen verzögerte Variablen erhalten ein Suffix_r1、_r2usw. Dies hat zwei Hauptvorteile. Erstens können während des RTL-Designs Daten einfach entsprechend dem Variablentyp bearbeitet werden. Zweitens ändern sich Signalnamen in der Post-Synthese-Netzliste häufig; das Hinzufügen von Suffixen erleichtert es, die entsprechenden Signalvariablen in der Post-Synthese-Netzliste zu finden, die denen im RTL entsprechen.

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

Weitere Suffixe:_dKönnen ein verzögertes Signal anzeigen,_tKönnen ein temporär gespeichertes Signal anzeigen,_nKönnen ein Low-aktives Signal anzeigen,_sKönnen ein Slave-Signal anzeigen,_mKönnen ein Master-Signal anzeigen, usw.

Vermeiden Sie die Verwendung von Schlüsselwörtern zum Benennen von Signalen, zum Beispiel sindin, out, x, znicht als Variablen zu empfehlen.

Dateinamen sollten mit demModulnamen des Designs übereinstimmen, und versuchen Sie, nur ein Designmodul pro Datei aufzunehmen.

Über Kommentare

Jedes Designmodul sollte mit Informationen zur Dateibeschreibung beginnen, einschließlich Copyright, Modulname, Autor, Datum, Zusammenfassung, Änderungsverlauf usw. Zum Beispiel:

/**********************************************************
// 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.
************************************************************/

Kommentare sollten die durch den Code beschriebene Bedeutung prägnant ausdrücken. Kurze Kommentare werden nach einer einzelnen Codezeile hinzugefügt, während lange Kommentare in der Zeile davor geschrieben werden sollten.

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

Kommentare sollten möglichst auf Englisch geschrieben werden, um sicherzustellen, dass sie auf verschiedenen Betriebssystemen und Editoren korrekt angezeigt werden.

Unter den Portsignalen ist es, außer bei gängigen Takt- und Reset-Signalen, am besten, auch andere Signale zu kommentieren.

Kommentare sind sehr mächtig. Sie können Kommentarinformationen verwenden, um Timing-Diagramme zu zeichnen, und sogar Kommentare nutzen, um Strukturdiagramme digitaler Schaltungen zu zeichnen.

Zur Optimierung

Verwenden Sie Klammern, um die Priorität oder die logische Struktur des Programms zu bestimmen. Um Designfehler aufgrund von Operator-Prioritätsproblemen zu vermeiden, wird empfohlen, Klammern häufig zu verwenden. Gleichzeitig kann eine geschickte Verwendung von Klammern manchmal die Struktur nach der Logiksynthese optimieren. Zum Beispiel:

    // oft zu 3 seriellen Addierern synthetisiert
    assign F = A + B + C + D ;
    // oft zu 2 parallelen Addierern und 1 Kaskadenaddierer synthetisiert, mit entspannteren Timing-Anforderungen
    assign F = (A + B) + (C + D) ;
 
    // Nicht empfohlen
    assign flag = cnt == 4'd2 && mode == 2'b01;
    // Empfohlen
    assign flag = (cnt == 4'd2) && (mode == 2'b01);  

Verwenden Sie für bedingte Anweisungen nach Möglichkeit case-Anweisungen anstelle von if-Anweisungen. Wenn auf derselben Ebene zu viele bedingte Prüfanweisungen vorhanden sind, verbraucht die aus case-Anweisungen synthetisierte Hardwarestruktur oft weniger Ressourcen und hat ein besseres Timing als die aus if-Anweisungen.

Versuchen Sie beim Schreiben von Zustandsmaschinen, den 3-Segment-Stil zu verwenden, um sicherzustellen, dass der Code sauber und sicher ist.

Versuchen Sie beim Entwurf eines Systems, die Methode anzuwenden, Module nach Funktion aufzuteilen und dann Module zu instanziieren. Im Vergleich zum Integrieren von Tausenden Codezeilen in eine Datei ist die Modulaufteilung für die Teamarbeit vorteilhaft und einfach zu aktualisieren und zu warten.

Zur Sauberkeit

Stellen Sie sicher, dass für Port-Signale ein Signal pro Zeile steht, wobei das Komma direkt nach der Port-Deklaration steht. Wer OCD hat, soll bitte auch die Kommas ausgerichtet halten.

// Nicht empfohlen
module even_divisor (input rstn, clk, output clk_div2, clk_div4, clk_div10) ;

// Empfohlen
module even_divisor    (
    input               rstn     ,
    input               clk      ,
    output              clk_div2 ,
    output              clk_div4 ,
    output              clk_div10
    );

Wenn eine Codezeile zu lang ist, versuchen Sie, sie ohne Verwendung eines Zeilenfortsetzungszeichens auf eine neue Zeile umzubrechen, zum Beispiel:

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

Versuchen Sie, begin + end zu verwenden, um die Kaskadenbeziehung zwischen Ausführungsanweisungen sicherzustellen. begin sollte in derselben Zeile wie das Schlüsselwort stehen, und end sollte in einer neuen Zeile stehen. Wenn Sie beispielsweise einen always-Block verwenden oder wenn eine bedingte Anweisung nur eine Ausführungsanweisung enthält, können die Schlüsselwörter begin + end weggelassen werden. Um jedoch die strukturelle Integrität sicherzustellen und zukünftiges Debugging und Änderungen zu erleichtern, wird empfohlen, solche Schlüsselwörter hinzuzufügen.

   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

Versuchen Sie, die Tabulatortaste und Leerzeichen zu verwenden, um sicherzustellen, dass Anweisungen entsprechend der hierarchischen Struktur ausgerichtet sind. Zwischen Variablen, Schlüsselwörtern und Operatoren sollten ebenfalls Leerzeichen stehen, um die logische Beurteilung zu erleichtern.

   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

Beim Instanziieren von Modulen sollten Portsignale und Verbindungssignale möglichst getrennt und jeweils ausgerichtet werden. Wenn das Verbindungssignal ein Vektor ist, geben Sie seine Bitbreite an, um das Lesen und Debuggen zu erleichtern.

    ram u_ram(
        .CLK_WR          (clk),
        .WR_EN           (wren), // Nicht schreiben, wenn voll
        .ADDR_WR         (addr),
        .D               (wdata[9:0]),
        .Q               (rdata[31:0])
        );

Beim Instanziieren mehrerer identischer Module sollten möglichst generate-Anweisungen verwendet werden, um übermäßig lange Instanziierungscode-Beschreibungen zu vermeiden.