Wie schreibe ich Dokumentationskommentare in ANSI C?[geschlossen]

Question

Ich kann in C keine Kommentare schreiben. Ich meine, ich weiß über // und /* */ Bescheid. Ich meine, wo finde ich bewährte Methoden?Wie schreibe ich den @param variable is the value bla bla, wenn ich eine Funktion habe, wie es in Java gemacht wird?

Gibt es dafür Standards?Oder kann ich es einfach so machen, wie ich es in Java mache?

Answer 1

Es gibt viele verschiedene Standards. Wenn Sie Dokumentation erstellen möchten, versuchen Sie es mit Sauerstoff

Answer 2

Es gibt keine Standards, die dem von Ihrem Unternehmen vorgeschriebenen Standard entsprechen.
Eine beliebte Methode zum Erstellen von Dokumentationen aus Projekten ist die Verwendung von Sauerstoff .

Answer 3

Sie können den Javadoc-Standard verwenden und dann Sauerstoff verwenden, der Javadoc versteht, um eine Dokumentation zu erstellen.

In doxygen empfehle ich, die Option JAVADOC_AUTOBRIEF zu verwenden, die auf YES gesetzt ist.Wenn das Tag JAVADOC_AUTOBRIEF auf YES gesetzt ist, interpretiert doxygen die erste Zeile (bis zum ersten Punkt) eines Kommentars im Javadoc-Stil als Kurzbeschreibung.

Beispiel für eine Klassendefinition:

/**
 * A brief description. A more elaborate class description
 * @param bool somebool a boolean argument.
 * @see Test()
 * @return The test results
 */

(Weitere Beispiele im Sauerstoffhandbuch )

Die Installation ist sehr einfach, es gibt eine grafische Benutzeroberfläche und eine schöne grafische Visualisierung mit:

apt-get install doxygen doxygen-gui graphviz

Führen Sie die GUI aus, die doxywizard aufruft, und verwenden Sie die Einstellungen des Assistenten. In den Einstellungen "Experte" muss nur JAVADOC_AUTOBRIEF festgelegt werden.

Answer 4

Eine Option ist die Verwendung des Doxygen-Formats zum Schreiben von Kommentaren. Dies hat den zusätzlichen Vorteil, dass HTML / Latex und andere Arten von Dokumenten für Ihren Code generiert werden können.