Was sind die häufigsten Namenskonventionen in C?

Welche Namenskonventionen werden üblicherweise in C verwendet? Ich weiß, dass es mindestens zwei gibt:

1. GNU / linux / K & R mit Kleinbuchstabenfunktionen
2. ? Name ? mit UpperCaseFoo-Funktionen

Ich spreche nur hier von C. Die meisten unserer Projekte sind kleine eingebettete Systeme, in denen wir C verwenden.

Hier ist die, die ich für mein nächstes Projekt verwenden möchte:

C Namenskonvention

Struct              TitleCase
Struct Members      lower_case or lowerCase

Enum                ETitleCase
Enum Members        ALL_CAPS or lowerCase

Public functions    pfx_TitleCase (pfx = two or three letter module prefix)
Private functions   TitleCase
Trivial variables   i,x,n,f etc...
Local variables     lower_case or lowerCase
Global variables    g_lowerCase or g_lower_case (searchable by g_ prefix)

Das Wichtigste dabei ist die Konsistenz. Trotzdem folge ich der GTK + -Codierungskonvention, die wie folgt zusammengefasst werden kann:

1. Alle Makros und Konstanten in Großbuchstaben: MAX_BUFFER_SIZE, TRACKING_ID_PREFIX.
2. Strukturnamen und Typedefs in camelcase: GtkWidget, TrackingOrder.
3. Funktionen, die mit Strukturen arbeiten: klassischer C-Stil: gtk_widget_show(), tracking_order_process().
4. Zeiger: hier nichts Besonderes: GtkWidget *foo, TrackingOrder *bar.
5. Globale Variablen: Verwenden Sie einfach keine globalen Variablen. Sie sind böse.
6. Funktionen, die vorhanden sind, aber nicht direkt aufgerufen werden sollten oder unklare Verwendungszwecke haben oder was auch immer: ein oder mehrere Unterstriche am Anfang: _refrobnicate_data_tables(), _destroy_cache().

"Strukturzeiger" sind keine Entitäten, die eine Namenskonventionsklausel benötigen, um sie abzudecken. Sie sind einfach struct WhatEver *. Verstecken Sie nicht die Tatsache, dass es sich um einen Zeiger handelt, der mit einem cleveren und "offensichtlichen" Typedef verbunden ist. Es hat keinen Zweck, ist länger zu tippen und zerstört das Gleichgewicht zwischen Deklaration und Zugriff.

Erstens hat C keine öffentlichen / privaten / virtuellen Funktionen. Das ist C ++ und es gibt verschiedene Konventionen. In C haben Sie normalerweise:

• Konstanten in ALL_CAPS
• Unterstreichungen, um Wörter in Strukturen oder Funktionsnamen abzugrenzen, sehen Sie in C kaum einen Kamelfall;
• Strukturen, Typedefs, Gewerkschaften, Mitglieder (von Gewerkschaften und Strukturen) und Aufzählungswerte werden (meiner Erfahrung nach) normalerweise in Kleinbuchstaben geschrieben und nicht in der C ++ / Java / C # / etc-Konvention, den ersten Buchstaben zu einem Großbuchstaben zu machen, aber ich denke, es ist möglich in C auch.

C ++ ist komplexer. Ich habe hier eine echte Mischung gesehen. Kamelbuchstaben für Klassennamen oder Kleinbuchstaben + Unterstriche (Kamelbuchstaben sind meiner Erfahrung nach häufiger). Strukturen werden selten verwendet (und normalerweise, weil eine Bibliothek sie benötigt, andernfalls würden Sie Klassen verwenden).

Weißt du, ich halte es gerne einfach, aber klar ... Also hier ist, was ich in C verwende:

• Triviale Variablen : i,n,cusw. (Nur ein Buchstabe. Wenn ein Buchstabe nicht klar ist, machen Sie ihn zu einer lokalen Variablen.)
• Lokale Variablen :lowerCamelCase
• Globale Variablen :g_lowerCamelCase
• Konstantenvariablen :ALL_CAPS
• Zeigervariablen : Fügen Sie a hinzup_ dem Präfix ein hinzu. Für globale Variablen wäre es gp_varfür lokale Variablen p_varfür const-Variablen p_VAR. Wenn Fernzeiger verwendet werden, verwenden Sie ein fp_anstelle von p_.
• Strukturen : ModuleCamelCase(Modul = vollständiger Modulname oder Abkürzung mit 2-3 Buchstaben, aber immer noch in CamelCase.)
• Strukturelementvariablen :lowerCamelCase
• Aufzählungen :ModuleCamelCase
• Enum-Werte :ALL_CAPS
• Öffentliche Funktionen :ModuleCamelCase
• Private Funktionen :CamelCase
• Makros :CamelCase

Ich schreibe meine Strukturen, benutze aber den gleichen Namen für das Tag und das typedef. Das Tag ist nicht für die allgemeine Verwendung vorgesehen. Stattdessen ist es vorzuziehen, das typedef zu verwenden. Ich deklariere auch das typedef im öffentlichen Modul-Header zur Kapselung weiter, damit ich den typedef'd-Namen in der Definition verwenden kann.

Vollständiges struct Beispiel :

typdef struct TheName TheName;
struct TheName{
    int var;
    TheName *p_link;
};

Codierung in C #, Java, C, C ++ und Ziel C. habe ich eine sehr einfache und klare Namenskonvention eingeführt, um mein Leben zu vereinfachen.

Zuallererst stützt es sich auf die Leistungsfähigkeit moderner IDEs (wie Eclipse, Xcode ...) mit der Möglichkeit, schnelle Informationen durch Schweben oder Klicken bei gedrückter Strg-Taste zu erhalten. Als ich dies akzeptierte, unterdrückte ich die Verwendung von Präfixen und Suffixen und andere Marker, die einfach von der IDE gegeben werden.

Dann die Konvention:

• Alle Namen MÜSSEN ein lesbarer Satz sein, der erklärt, was Sie haben. Wie "das ist meine Konvention".
• Dann 4 Methoden, um eine Konvention aus einem Satz herauszuholen:
  1. THIS_IS_MY_CONVENTION für Makros, Enum-Mitglieder
  2. ThisIsMyConvention für Dateiname, Objektname (Klasse, Struktur, Aufzählung, Union ...), Funktionsname, Methodenname, typedef
  3. this_is_my_convention globale und lokale Variablen,
     Parameter, Struktur- und Vereinigungselemente
  4. thisismyconvention [optional] sehr lokale und temporäre Variablen (wie ein for () - Schleifenindex)

Und das ist es.

Es gibt

class MyClass {
    enum TheEnumeration {
        FIRST_ELEMENT,
        SECOND_ELEMENT,
    }

    int class_variable;

    int MyMethod(int first_param, int second_parameter) {
        int local_variable;
        TheEnumeration local_enum;
        for(int myindex=0, myindex<class_variable, myindex++) {
             localEnum = FIRST_ELEMENT;
        }
    }
}

Ich würde empfehlen, Kamelfall und Unterstrich nicht zu mischen (wie Sie es für Strukturmitglieder vorgeschlagen haben). Das ist verwirrend. Sie würden denken, hey ich habe, get_lengthalso sollte ich wahrscheinlich haben make_subsetund dann finden Sie heraus, dass es tatsächlich ist makeSubset. Verwenden Sie das Prinzip des geringsten Erstaunens und seien Sie konsequent.

Ich finde CamelCase nützlich, um Namen wie Strukturen, Typedefs und Enums einzugeben. Das ist aber alles. Für den Rest (Funktionsnamen, Namen der Strukturelemente usw.) verwende ich underscore_separation.

Hier ist eine (anscheinend) ungewöhnliche, die ich nützlich gefunden habe: Modulname in CamelCase, dann Unterstrich, dann Funktions- oder Dateibereichsname in CamelCase. Also zum Beispiel:

Bluetooth_Init()
CommsHub_Update()
Serial_TxBuffer[]

Eines verwirrt mich: Sie planen, eine neue Namenskonvention für ein neues Projekt zu erstellen. Im Allgemeinen sollten Sie eine Namenskonvention haben, die unternehmens- oder teamweit ist. Wenn Sie bereits Projekte mit einer Namenskonvention haben, sollten Sie die Konvention für ein neues Projekt nicht ändern. Wenn die obige Konvention nur eine Kodifizierung Ihrer bestehenden Praktiken ist, dann sind Sie golden. Je mehr es sich von bestehenden de facto unterscheidet Standards schwieriger wird es, sich über den neuen Standard Gedanken zu machen.

Der einzige Vorschlag, den ich hinzufügen möchte, ist, dass ich _t am Ende von Typen im Stil von uint32_t und size_t mag. Es ist sehr C-ish für mich, obwohl einige sich beschweren könnten, dass es nur "umgekehrt" ungarisch ist.

Sie sollten auch über die Reihenfolge der Wörter nachdenken , um die automatische Namensvervollständigung durchzuführen vereinfachen.

Eine gute Vorgehensweise: Bibliotheksname + Modulname + Aktion + Betreff

Wenn ein Teil nicht relevant ist, überspringen Sie es einfach, aber es sollten immer mindestens ein Modulname und eine Aktion angezeigt werden.

Beispiele:

• Funktionsname: os_task_set_prio, list_get_size,avg_get
• definieren (hier normalerweise kein Aktionsteil ):OS_TASK_PRIO_MAX

Es könnte viele geben, hauptsächlich IDEs, die einige Trends diktieren, und auch C ++ - Konventionen drängen. Für C häufig:

• UNDERSCORED_UPPER_CASE (Makrodefinitionen, Konstanten, Aufzählungselemente)
• underscored_lower_case (Variablen, Funktionen)
• CamelCase (benutzerdefinierte Typen: Strukturen, Aufzählungen, Gewerkschaften)
• uncappedCamelCase (im Java-Stil)
• UnderScored_CamelCase (Variablen, Funktionen unter Namespaces)

Die ungarische Notation für Globale ist in Ordnung, aber nicht für Typen. Und selbst für triviale Namen verwenden Sie bitte mindestens zwei Zeichen.

Ich denke, diese können für Anfänger hilfreich sein: Namenskonvention von Variablen in c

1. Sie müssen alphabetisches Zeichen (az, AZ), Ziffer (0-9) und Under Score (_) verwenden. Es ist nicht erlaubt, Sonderzeichen wie:%, $, #, @ usw. zu verwenden. Sie können also Benutzername als Variable verwenden, Benutzer & Name jedoch nicht .
2. Leerzeichen zwischen Wörtern können nicht verwendet werden. Sie können also Benutzername oder Benutzername oder Benutzername als Variable verwenden, aber keinen Benutzernamen verwenden .
3. Kann nicht mit der Ziffer benennen. Sie können also Benutzer1 oder Benutzer2 als Variable verwenden, 1user jedoch nicht .
4. Es ist Groß- und Kleinschreibung. Groß- und Kleinbuchstaben sind von Bedeutung. Wenn Sie eine Variable wie Benutzername verwenden , können Sie weder USERNAME noch Benutzername verwenden für die Verwendung durch den Vater verwenden.
5. Sie können kein Schlüsselwort verwenden (char, int, if, for, while usw.) für die Variablendeklaration verwenden.
6. Der ANSI-Standard erkennt eine Länge von 31 Zeichen für einen Variablennamen