Hinweise zur C++-Überprüfung – Allgemeine C++-Kommentarspezifikationen

Inhaltsverzeichnis

1 – Häufig verwendete Anmerkungsspezifikationen

2 – Codebeispiele

---

1 – Häufig verwendete Anmerkungsspezifikationen

① @brief bedeutet Einführung und wird verwendet, um die Rolle und Funktion der Funktion oder Klasse kurz vorzustellen.

② @param stellt Parameter dar und dient zur Einführung und Erläuterung der Parameter von Funktionen oder Klassen.

③ @return stellt den Rückgabetyp dar und wird zur Beschreibung des Rückgabetyps der Funktion verwendet.

④ @author repräsentiert den Autor und wird zur Einführung von Autoreninformationen verwendet;

⑤ @data stellt das Datum dar und wird zur Einführung von Datumsinformationen verwendet.

⑥ @version stellt die Version dar und wird zur Einführung von Versionsinformationen verwendet.

⑦ @Exception wird verwendet, um mögliche Ausnahmeinformationen zu beschreiben;

⑧ @property stellt Attribute dar und wird zur Beschreibung von Attributinformationen verwendet.

⑨ @retval stellt den Rückgabewert dar und wird verwendet, um die Bedeutung des Rückgabewerts zu erklären (z. B. kann -1 eine Ausnahme anzeigen).

2 – Codebeispiele

Sie können /** */         verwenden  , um regionale Kommentare abzugeben, oder Sie können /// verwenden , um einzelne Kommentare abzugeben;

#include <iostream>

int my_func1(int param1, int param2){
/**
    @brief A function that calculates the sum of two input integers.
    @param param1: The input interger.
    @param param2: The other input interger.
    @return int.
    @author liujinfu.
    @date 2023.09.15.
    @version 1.0.
*/
    return param1 + param2;
}

int my_func2(int param1, int param2){

/// @brief A function that calculates the sum of two input integers.
/// @param param1: The input interger.
/// @param param2: The other input interger.
/// @return int.
/// @author liujinfu.
/// @date 2023.09.15.
/// @version: 1.0.

    return param1 + param2;
}

int main(int argc, char* argv[]){
    int a = 1, b = 2;
    int c = my_func1(a, b);
    std::cout << c << std::endl;
    return 0;
}