Warum braucht ein C-Kommentar wie /* */ ‘

Lesezeit: 1 Minute

Benutzeravatar von kingkai
Königkai

Die C-Code-Richtlinien meines Teams schreiben, dass es besser wäre, ein ‘<' in einen Kommentar zu setzen, wie unten gezeigt:

#define MAX_PACK_ITEM_NUM 50  /**<  max number of item */

Ich frage mich, was ist der wahre Nutzen dieses ‘<'?

  • Wie lautet die Antwort Ihres Teams?

    – Henrik

    7. September 2011 um 6:13 Uhr

  • Warum wollen die Leute das schließen? Es ist eine absolut berechtigte Frage!

    – Michael Foukarakis

    7. September 2011 um 6:17 Uhr

  • vielleicht ein Hinweis auf einen Dokumentationsgenerator..

    – dudl0r

    7. September 2011 um 6:18 Uhr

  • Ich bin mir sicher, dass nur wenige Leute etwas aus dieser Frage gelernt haben, und ob sie als lokalisiert angesehen werden kann, hat Meta eine ziemlich gute Antwort: meta.stackexchange.com/questions/4818/…

    – Michael Foukarakis

    7. September 2011 um 7:24 Uhr


  • @VJo: Wenn es eine unternehmensspezifische Konvention wäre, würde ich zustimmen, aber wie sich herausstellt, geht es um Doxygen – und es sind derzeit 413 Fragen markiert [doxygen].

    – Keith Thompson

    7. September 2011 um 8:08 Uhr

Benutzeravatar von Michael Foukarakis
Michael Foukarakis

Es ist ein Weg für doxygen um Dokumentation für Mitglieder einer Datei/Struktur/Union/Klasse/Enum zu generieren. Indem Sie diese Markierung verwenden, können Sie nach jedem Mitglied Kommentare einfügen, was zu weniger Unordnung führt. Sie können mehr darüber lesen hier.

Wie andere geantwortet haben, ist dies wahrscheinlich ein Kommentar, der für Doxygen bestimmt ist. Beim Analysieren von Kommentaren gelten für doxygen einige Sonderregeln:

  • Ein gewöhnlicher Kommentar, der mit beginnt /* ist ignoriert durch Sauerstoff.
  • Ein Kommentar, der mit beginnt /** wird als Dokumentation der behandelt nächster Artikel nach dem Kommentar im Quellcode.
  • Ein Kommentar, der mit beginnt /**< wird als Dokumentation des Artikels behandelt unmittelbar bevor den Kommentar im Quellcode.

Die Dokumentation wird meistens über dem dokumentierten Objekt platziert, zB einer Funktion. Aber in manchen Fällen wie z #define Es ist sinnvoll, die Dokumentation stattdessen an das Ende der Zeile zu stellen und in diesem Fall die /**< Marker benötigt.

Benutzeravatar von Juraj Blaho
Juraj Blaho

Es ist ein doxygen-Syntax für kommentierende Mitglieder nach Deklaration/Definition.

Benutzeravatar von ThiefMaster
DiebMeister

Ich nehme an, Ihr Team verwendet ein automatisiertes Dokumentationstool, das sucht /**<; z.B Sauerstoff.

1408190cookie-checkWarum braucht ein C-Kommentar wie /* */ ‘

This website is using cookies to improve the user-friendliness. You agree by using the website further.

Privacy policy