mikrocontroller.net

Forum: Compiler & IDEs Atmel Studio - Automatische Generierung von Kommentaren für Doxygen


Announcement: there is an English version of this forum on EmbDev.net. Posts you create there will be displayed on Mikrocontroller.net and EmbDev.net.
Autor: Mirco G. (mirco432)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Guten Abend!

ich wollte mal fragen ob es ein Tool für Atmel Studio gibt welches mir 
Kommentare passend für Doxygen generiert.

Mit VA-Snippet müsste es möglich sein sich passende Einträge anzulegen, 
aber wenn man das für jedes zu Kommentierende Objekt macht ist man auch 
ein bisschen beschäftigt.

Da hat sich doch bestimmt schon jemand Gedanken zu gemacht oder?

Vielen Dank!

Mirco

Autor: Mirco G. (mirco432)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Also sowas hier :

https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen

nur halt für Atmel studio

Obwohl Atmel studio doch irgendwie auf Visual Studio aufbaut oder? 
Bekommt man das vielleicht irgendwie implementiert?

Autor: Karl M. (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Das ist irgendwie unsinnig: Meine Gedanken mein Kommentar, wie soll das 
automatisch erfolgen?

Das Stichwort heißt: "Literate programming"
Damit ging es damals bei uns los, meine Ausgabe des Buchs stammt von 
1991.

https://en.wikipedia.org/wiki/Literate_programming#/media/File:Literate_Programming_book_cover.jpg

https://en.wikipedia.org/wiki/Literate_programming

Ist das bekannt?

Autor: Mirco G. (mirco432)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Nein davon hatte ich noch nichts gehört. Ich schaue mir das auch mal 
noch genauer an.

Trotzdem komme ich um eine Dokumentation in Form von Doxygen nicht 
herum. Wird für mein Projekt so gefordert.

Karl M. schrieb:
> Das ist irgendwie unsinnig: Meine Gedanken mein Kommentar, wie soll das
> automatisch erfolgen?

Es geht ja auch nicht darum das der Kommentar inhaltlich gefüllt wird. 
Nur das der äußere Aufbau automatisch erzeugt wird und es so ein wenig 
angenehmer wird.

Autor: Michael F. (michaelfu)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Mirco G. schrieb:
> Es geht ja auch nicht darum das der Kommentar inhaltlich gefüllt wird.
> Nur das der äußere Aufbau automatisch erzeugt wird und es so ein wenig
> angenehmer wird.

Gibt es in Atmel Studio die Möglichkeit, sich Code-Templates zu 
definieren, die dann per Tastenkürzel eingefügt werden können?

Ich kenne das von einer anderen IDE, mit der man sich den Kommentar im 
Doxygen-Style als Vorlage definieren kann, damit man da nicht komplett 
von 0 beginnen muss...

Autor: W.S. (Gast)
Datum:

Bewertung
-1 lesenswert
nicht lesenswert
Mirco G. schrieb:
> ein Tool .. welches ... Kommentare passend für Doxygen generiert.

Das ist der Widersinn in kristalliner Form.

Ein Kommentar soll im Quelltext dem geneigten Leser sagen, was der Autor 
an dieser Stelle in seinem Sinn gehabt hat. Das ist was Menschliches 
und es ist durch keinerlei Automaten ersetzbar - es sei denn, man 
verzichtet auf jeglichen Sinngehalt und will nur eine Form wahren.

W.S.

Autor: Yalu X. (yalu) (Moderator)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
W.S. schrieb:
> Das ist der Widersinn in kristalliner Form.
> ...

Darum geht es doch gar nicht.

Mirco G. schrieb:
> Es geht ja auch nicht darum das der Kommentar inhaltlich gefüllt wird.
> Nur das der äußere Aufbau automatisch erzeugt wird und es so ein wenig
> angenehmer wird.

So etwas gibt es für jeden besseren Editor bzw. IDE. Ob auch 
Atmel/Visual Studio dazugehört, weiß ich nicht, da ich es nicht benutze.

Antwort schreiben

Die Angabe einer E-Mail-Adresse ist freiwillig. Wenn Sie automatisch per E-Mail über Antworten auf Ihren Beitrag informiert werden möchten, melden Sie sich bitte an.

Wichtige Regeln - erst lesen, dann posten!

  • Groß- und Kleinschreibung verwenden
  • Längeren Sourcecode nicht im Text einfügen, sondern als Dateianhang

Formatierung (mehr Informationen...)

  • [c]C-Code[/c]
  • [avrasm]AVR-Assembler-Code[/avrasm]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] - Link zu Artikel
  • Verweis auf anderen Beitrag einfügen: Rechtsklick auf Beitragstitel,
    "Adresse kopieren", und in den Text einfügen




Bild automatisch verkleinern, falls nötig
Bitte das JPG-Format nur für Fotos und Scans verwenden!
Zeichnungen und Screenshots im PNG- oder
GIF-Format hochladen. Siehe Bildformate.

Mit dem Abschicken bestätigst du, die Nutzungsbedingungen anzuerkennen.