bb2
Ich kann nicht finden, wie man Kommentare in C schreibt. Ich meine, ich weiß Bescheid // und /* */, was ich meine ist, wo kann ich gute Praktiken finden? Wie wenn ich eine Funktion habe, wie schreibe ich die @param variable is the value bla blawie es in Java gemacht wird?
Gibt es dafür Normen? Oder kann ich es einfach so machen, wie ich es in Java mache?
Dhaivat Pandya
Es gibt viele verschiedene Standards, wenn Sie Dokumentation erstellen möchten, versuchen Sie es Sauerstoff
rubo77
Sie können Javadoc-Standard verwenden und dann verwenden Sauerstoff das javadoc versteht, um eine Dokumentation zu generieren.
In doxygen empfehle ich die Verwendung der Option JAVADOC_AUTOBRIEF einstellen YES. Wenn das Tag JAVADOC_AUTOBRIEF auf YES gesetzt ist, interpretiert doxygen die erste Zeile (bis zum ersten Punkt) eines Kommentars im Javadoc-Stil als kurze Beschreibung.
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
*/
(Noch ein paar Beispiele im Doxygen-Handbuch)
Die Installation ist wirklich einfach, es gibt eine GUI und eine schöne grafische Visualisierung mit:
apt-get install doxygen doxygen-gui graphviz
Führen Sie den GUI-Aufruf aus doxywizard und verwenden Sie nur die Assistenteneinstellungen JAVADOC_AUTOBRIEF muss dort in den “Experten”-Einstellungen eingestellt werden.
Eine schöne Antwort mit einem Beispiel.
– Zeichnete
22. Dezember 2015 um 6:06 Uhr
Alok Speichern
Es gibt keine Standards, die dem Standard folgen, den Ihr Unternehmen vorschreibt.
Eine beliebte Methode zum Erstellen von Dokumentationen aus Projekten ist die Verwendung Sauerstoff.
Eine Option ist die Verwendung des Doxygen-Formats zum Schreiben von Kommentaren – dies hat den zusätzlichen Vorteil, dass Sie HTML/Latex und andere Arten von Dokumenten für Ihren Code generieren können.
Eigentlich kann man gar nicht verwenden
//in ANSI C. Erst ab C99 erlaubten sie//. (Obwohl GCC es als Erweiterung erlaubt.)– Mystisch
17. Januar 2012 um 5:10 Uhr
Nur
/* */wird in C unterstützt.//ist eine Ergänzung in C++– Shiplu Mokadim
17. Januar 2012 um 5:12 Uhr
Der Begriff “ANSI C” bezieht sich normalerweise auf die Sprache, die durch den ANSI-Standard von 1989 beschrieben wird, aber genau genommen ist das falsch. 1990 gab die ISO denselben Standard heraus (mit einigen neuen Einführungsmaterialien und neu nummerierten Abschnitten), und ANSI übernahm ihn. 1999 gab ISO einen neuen C-Standard heraus, und ANSI übernahm ihn ebenfalls, wodurch der Standard von 1989/1990 offiziell obsolet wurde. Ende 2011 hat ISO eine weitere neue C-Norm herausgegeben, die auch ANSI übernommen hat. Mit Ausnahme der ersten werden C-Normen ursprünglich von ISO veröffentlicht, nicht von ANSI – und es ist am besten, sich auf die Normen nach Jahr zu beziehen.
– Keith Thompson
17. Januar 2012 um 5:16 Uhr
Leider gibt es immer noch Compiler, die nicht einmal den ISO-C-Standard von 1999 unterstützen. Der Standard von 1990 wird fast überall unterstützt.
– Keith Thompson
17. Januar 2012 um 5:17 Uhr
@KeithThompson Sehr wahr – Compiler implementieren C ++ 89 immer noch nicht – Ich wusste nicht, dass C auch überarbeitet werden sollte – Ich habe mich auf C ++ 0x (oder C ++ 11, wie es jetzt bekannt ist) konzentriert. Scheint, es gibt sehr wenig Änderungen – was für eine Zeitverschwendung.
– Adrian Kornisch
17. Januar 2012 um 5:25 Uhr