Lesbarkeit und Konsistenz von C++-Funktionsnamen

Antwort: C++-Funktionsnamen sollten lesbar und konsistent sein, um die Wartbarkeit und Verständlichkeit des Codes zu verbessern. Richtlinien zur Lesbarkeit: Verwenden Sie beschreibende Namen. Vermeiden Sie die Verwendung von Gerundien. Richtlinien zur Konsistenz: Verwenden Sie konsistente Namenskonventionen. Verwenden Sie die Pascal- oder Camel-Nomenklatur um die Absicht zu vermitteln und den Code leicht lesbar zu machen. Das Befolgen der Prinzipien der Lesbarkeit und Konsistenz kann die Wartbarkeit und Verständlichkeit des Codes erheblich verbessern.

Richtlinien zur Lesbarkeit

Verwenden Sie beschreibende Namen:

Funktionsnamen sollten klar angeben, was die Funktion tut, Abkürzungen oder mehrdeutige Namen vermeiden. Zum Beispiel:

int calculate_total_cost();

Vermeiden Sie die Verwendung von Gerundien:

Gerunden machen Funktionsnamen lang und schwer lesbar. Die Verwendung von Verbformen ist prägnanter und klarer. Zum Beispiel:

• void write_file(const std::string& filename); // 避免：writeFile()
  int calculate_total_cost(); // 避免：calculateTotalCost()

Konsistenzrichtlinien

• Verwenden Sie eine konsistente Namenskonvention:
Für Funktionen desselben Typs oder Zwecks sollte eine konsistente Namenskonvention verwendet werden. Dies hilft, den Code schnell zu identifizieren und zu verstehen. Zum Beispiel:

// 用"_t"后缀表示 template 函数
template<typename T> void print_array(const T* array, int size);
template<typename T> void print_list(const std::list<T>& list);

Verwenden Sie die Pascal- oder Camel-Nomenklatur:

Für Namen mit mehreren Wörtern verwenden Sie die Pascal-Nomenklatur (der erste Buchstabe jedes Wortes wird groß geschrieben) oder die Camel-Nomenklatur (das erste Wort ist kleingeschrieben und der erste Buchstabe des (die restlichen Wörter werden groß geschrieben) sollte verwendet werden.

• Pascal: CalculateTotalCost()
  Camel: calculateTotalCost()

Praktisches Beispiel

• Lassen Sie uns diese Richtlinien verwenden, um die Funktionsnamen im folgenden C++-Code zu verbessern:

  // 原代码
  int calc_cost(int items, double price);
  void writeToLog(const std::string& msg);
  
  // 改进后的代码
  int calculate_total_cost(int number_of_items, double item_price);
  void write_to_log(const std::string& message);

  Diese Verbesserungen verbessern die Lesbarkeit und Konsistenz des Codes und machen die Funktionalität der Funktion auf einen Blick klar.

Das obige ist der detaillierte Inhalt vonLesbarkeit und Konsistenz von C++-Funktionsnamen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!