C ++ Dokumentationsvorlagen [geschlossen]

8

Welche Vorlagen verwenden Sie, um Klassen, Methoden usw. in C ++ zu dokumentieren?

In Java macht Eclipse alles automatisch mit javadoc, aber gibt es einen Standard für C ++?

zum Beispiel

%Vor%     
Amir Rachum 03.01.2011, 21:42
quelle

3 Antworten

7

Doxygen (ein beliebtes Tool zum Generieren von Dokumenten aus C ++ - Code) unterstützt eine ganze Reihe verschiedener Formate . Es gibt wirklich kein standardmäßiges C ++ Dokumentationswerkzeug, aber dieses wird am Ende sehr gebraucht.

    
templatetypedef 03.01.2011, 21:46
quelle
1

In Eclipse können Sie CDT einrichten, um doxygen Kommentare zu Codestrukturen zu generieren, indem Sie Vorlagen Ihrer Wahl für neue Dateien, Klassen usw. verwenden.

Dies verwende ich für benutzerdefinierte Tags, die für meine Projekte geeignet sind

    
David 03.01.2011 23:08
quelle
0

Es gibt keinen Standard für die Dokumentation des Codes (Java, C oder C ++). Es gibt Werkzeuge, die die Dokumentation aus dem Quelltext machen und sie haben möglicherweise einen Standard in Arbeit .

Hier ist ein Stil, den ich im Laufe der Zeit angepasst habe:

%Vor%

Zu einer bestimmten Zeit hatte ich Eclipse, das dies in neue Dateien speicherte, die ich erstellt habe.
Ich speichere dies in einer Schablonendatei und kopiere die Datei, bevor ich neuen Code schreibe. Die Schablone hätte weder die Methodendeklarationen noch die Vererbungszeilen.

    
Thomas Matthews 03.01.2011 21:56
quelle

Tags und Links

Django: Verwenden von Annotate, Count und Distinct in einem Queryset Überlegungen zur Leistung der Vererbung in C #