Was sind die gängigsten Namenskonventionen in C?

Question 1

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

GNU / Linux / K&R mit Kleinbuchstabenfunktionen

? Name ? mit UpperCaseFoo-Funktionen

Ich spreche hier nur 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)

Question 2

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

Alle Makros und Konstanten in Großbuchstaben: MAX_BUFFER_SIZE, TRACKING_ID_PREFIX.
Strukturnamen und Typedefs in Camelcase: GtkWidget, TrackingOrder.
Funktionen, die mit Strukturen arbeiten: klassischer C-Stil: gtk_widget_show(), tracking_order_process().

Hinweise: nichts Besonderes hier:
GtkWidget *foo, TrackingOrder *bar.
Globale Variablen: Verwenden Sie einfach keine globalen Variablen. Sie sind böse.
Funktionen, die vorhanden sind, aber nicht direkt aufgerufen werden sollten oder obskure Verwendungen haben oder was auch immer: ein oder mehrere Unterstriche am Anfang:
_refrobnicate_data_tables(), _destroy_cache().

Question 3

“Strukturzeiger” sind keine Entitäten, die eine Namenskonventionsklausel benötigen, um sie abzudecken. Sie sind einfach struct WhatEver *. Verbergen Sie NICHT die Tatsache, dass ein Zeiger mit einer cleveren und “offensichtlichen” Typdefinition involviert ist. Es erfüllt keinen Zweck, ist länger zu tippen und zerstört die Balance zwischen Deklaration und Zugriff.

Question 4

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

Triviale Variablen: i,n,cetc … (Nur ein Buchstabe. Wenn ein Buchstabe nicht klar ist, dann machen Sie ihn zu einer lokalen Variablen)
Lokale Variablen: camelCase

Globale Variablen: g_camelCase
Konstante Variablen: ALL_CAPS
Zeigervariablen: füge hinzu ein p_ zum Präfix. Für globale Variablen wäre es gp_varfür lokale Variablen p_varfür konstante Variablen p_VAR. Wenn far-Zeiger verwendet werden, verwenden Sie an fp_ Anstatt von p_.

Strukturen: ModulePascalCase (Modul = vollständiger Modulname oder eine Abkürzung aus 2-3 Buchstaben, aber immer noch in PascalCase.)
Strukturmitgliedsvariablen: camelCase
Aufzählungen: ModulePascalCase

Enum-Werte: ALL_CAPS
Öffentliche Funktionen: ModulePascalCase
Private Funktionen: PascalCase

Makros: PascalCase

Ich typdefiniere meine Strukturen, verwende aber denselben Namen für das Tag und die Typdefinition. Das Tag soll nicht allgemein verwendet werden. Stattdessen ist es vorzuziehen, die typedef zu verwenden. Ich deklariere auch die Typedef im Header des öffentlichen Moduls für die Kapselung und damit ich den Typedef-Namen in der Definition verwenden kann.

Voll struct Beispiel:

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

Question 5

Nun, erstens hat C keine öffentlichen/privaten/virtuellen Funktionen. Das ist C++ und es hat andere Konventionen. In C haben Sie normalerweise:

Konstanten in ALL_CAPS
Unterstriche zum Trennen von Wörtern in Strukturen oder Funktionsnamen, kaum jemals sieht man Camel Case in C;
Structs, Typedefs, Unions, Members (von Unions und Structs) und Enum-Werte sind normalerweise in Kleinbuchstaben (meiner Erfahrung nach) und nicht in der C++/Java/C#/etc-Konvention, den ersten Buchstaben groß zu schreiben, aber ich denke, es ist möglich in C auch.

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

Question 6

Codierung ein C#, Java, C, C++ und objektives C Gleichzeitig habe ich eine sehr einfache und klare Namenskonvention angenommen, 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 Bewegen der Maus oder Strg-Klick zu erhalten … In Anbetracht dessen habe ich die Verwendung von Präfixen und Suffixen unterdrückt und andere Markierungen, 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 zu bekommen:
1. THIS_IS_MY_CONVENTION für Makros Aufzählungsmitglieder
2. Das ist meine Konvention für Dateiname, Objektname (class, struct, enum, union…), Funktionsname, Methodenname, typedef
3. das_ist_meine_Konvention globale und lokale Variablen,
  Parameter, Struct- und Union-Elemente
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;
        }
    }
}

Question 7

Hier ist ein (anscheinend) ungewöhnlicher, den ich nützlich fand: Modulname in CamelCase, dann ein Unterstrich, dann Funktions- oder Dateibereichsname in CamelCase. Also zum Beispiel:

Bluetooth_Init()
CommsHub_Update()
Serial_TxBuffer[]

Question 8

Ich würde davon abraten, Camel Case und Underscore-Trennung zu mischen (wie Sie es für Strukturmitglieder vorgeschlagen haben). Das ist verwirrend. Sie würden denken, he ich habe get_length also hätte ich es wohl haben sollen make_subset und dann findest du heraus, dass es tatsächlich so ist makeSubset. Verwenden Sie das Prinzip des geringsten Erstaunens und bleiben Sie konsequent.

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