Ändern doxygen Kommentar Stil in Eclipse

Question

Kann jemand den Stil für Doxygen Kommentare in Eclipse CDT bearbeiten?

Mit anderen Worten geben/** und drücke eingeben auf einer Linie, bevor eine Funktion gibt mir momentan so etwas wie:

/** 
* 
* @param one 
* @param two 
* @return 
*/ 
Foo(int one, int two); 

und ich möchte es mir geben, so etwas wie:

/**********************************************************************/ 
/// 
/// \param one 
/// \param two 
/// \return 
/***********************************************************************/ 
Foo(int one, int two); 

Auch plus eins, wenn jemand weiß, wie man dies mit einer Tastenkombination (wie alt - shift - j für Eclipse JDT).

Auch, FYI, die Tatsache, dass Eclipse CDT unterstützt Doxygen scheint jetzt eine wenig bekannte Tatsache basierend auf Google. Details siehe here. Doxygen kann unter den Projekteigenschaften aktiviert werden, indem Sie auf der Registerkarte "C/C++ Allgemein" "Projektspezifische Einstellungen aktivieren" auswählen und "Doxygen" auswählen. Meine CDT-Version ist 7.0.1, aber ich denke, das wurde in 5.0 verfügbar.

Zum Schluss, der Kommentarbereich unter Code-Vorlagen in den Einstellungen erreicht dies nicht basierend auf meinen Tests.

EDIT: Siehe here. Es scheint, als ob der Kommentarstil fest codiert ist. Wenn jemand etwas anderes findet, würde ich es gerne wissen. Ich denke, Vorlagen sind das Beste für den Moment, es sei denn, der Javadoc-Stil ist in Ordnung für Sie.

Answer 1

Ich kann etwas von dem, was Sie wollen, gehen, indem Sie: Einstellungen - PHP - Code-Stil - Code-Vorlagen - Kommentare.

Ich bin nicht sicher, dass dies ermöglicht Ihnen Backslashes anstelle von @s für Ihre Keywords verwenden, aber ich denke, es sollte das meiste von dem erreichen, was Sie wollen.

Answer 2

Dies ist eine Konfiguration, die ich

in meinem Java Kommentar gefunden und wenn ich als Kommentar meines java doc gezeigt bearbeitet geändert

Versuchen für ähnliche Konfiguration zu suchen unter deiner PHP-Konfiguration.

Answer 3

Ja, das scheint ein Fehler in Eclipse CDT zu sein.

Als Abhilfe, die ich vorschlagen, dass Sie eine eigene Vorlage erstellen, die mit der Ctrl +Raum Tastenkombination zugegriffen werden können.

in Eclipse Helios: Window -> Einstellungen -> C/C++ -> Editor -> Vorlagen

Klicken Sie auf Neu ... eine neue Vorlage zu erstellen und im Namen Feldeinsatz ein beschreibender Name, z"Kommentar-Funktion", und fügen Sie Ihren Doxygen-Kommentar in das Feld Muster. Bestätigen Sie diese Änderung und wenden Sie sie an.

In Ihrem Code können Sie dann über Ihre Funktionsdeklaration auf die Linie gehen, die ersten Buchstaben Ihres benutzerdefinierten Vorlagennamen durch die Ctrl +Raum Tastenkombination gefolgt eingeben.

In diesem Beispiel:

com<Ctrl+space> 

den Inhalt Assist Dialog gefiltert mit "com *" bringen, von dem Sie die "Kommentar-Funktion" Vorlage auswählen können.

Hinweis:

com<Ctrl+space+space> 

durch noch weiter nur zeigt Vorlage Vorschläge im Content Assist Popup-Fenster filtert.

Answer 4

Ein Doxygen-Tag verwendet dieses Basisformat.

/** 
Your tags and such. It MUST have the /** and the */. 
*/ 

Es muss unbedingt das/** */um den gesamten Doxygen-Kommentar haben. Wenn Sie die Code-Vorlagen ändern, wird es tun, was Sie wollen.

Der vorgeschlagene Kommentarstil ist jedoch falsch.

/***************/ <-- These are terminated Doxygen blocks. 
/// <-- These are used in xml style Doxygen blocks. 
/// 
/// This isn't actually a Doxygen block and shouldn't work 
/// if you run Doxygen on it. 
/// 
/***************/ <-- These are terminated Doxygen blocks. 

Dies unten ist Standard für die meisten Unternehmen, die in JAVA und Eclipse codieren. Da Doxygen für mehrere Sprachen gültig ist, gilt dies auch für C/C++.

/** 
* Brief description. 
* 
* @param[in|out] <value> <description> 
*/ 

Wenn Sie die XML-Style-Tags ...

/// <summary> 
/// This is a summary of the class, blah, blah. 
/// </summary> 

Sie auch wollen gehen, um sicherzustellen, Eclipse Einfügen nicht andere Kommentarstile verwenden möchten, beenden Sie können sonst mit Kommentaren, die in andere Kommentare eingefügt wurden. Im Allgemeinen ist es auch eine schlechte Regel, Kommentarstile wie/** */und /// zu mischen.

Schließlich, wenn Sie automatisch generieren Kommentare beim Erstellen von Klassen und solche Kommentare werden automatisch eingefügt werden. Und Sie können Eclipse automatisch Methodenheader während der Eingabe generieren (obwohl ich vergesse, wie ich dies getan habe).