Spezielle Art von Kommentaren: /**

[Roman K. (rk_aus_s)]

Hallo zusammen

Seit kurzem versuche ich, mich in die AVR Programmierung in C 
einzulesen.
Nicht, dass ich jetzt schon alles verstanden hätte, aber ich stolpere 
immer wieder über folgende Schreibweise und frage mich, was das für eine 
spezielle Art von Kommentaren sein könnte?:

/**
   \defgroup util_setbaud <util/setbaud.h>: Helper macros for baud rate calculations
   \code
   #define F_CPU 11059200
   #define BAUD 38400
   #include <util/setbaud.h>
   \endcode

   This header file requires that on entry values are already defined
   for F_CPU and BAUD.
   [...]

Was hat es mit den Slash und den zwei Sternchen auf sich? Im Vergeich zu 
"normalen" Kommentaren mit Slash und einem Sternchen (/*...*/) werden 
diese in meinem Editor sogar in einer anderen Farbe dargestellt. Ich 
habe solchen Code auch hier im Forum öfters gesehen, werde aber trotz 
langer Suche nicht recht schlau daraus?

Grüsse
Roman

[Carl D. (jcw2)]

https://de.m.wikipedia.org/wiki/Doxygen

[Alexander (Gast)]

Naja, wenn /* eine Kommentar einleitet, kann dann das erste Zeichen 
danach wieder ein * sein, also /**.

Und zum Abschluß halt das */.

[rbx (Gast)]

Roman K. schrieb:
> Was hat es mit den Slash und den zwei Sternchen auf sich?

Hinweis auf Funktionsbeschreibung und/oder Ähnliches.

[Teo D. (teoderix)]

http://codenode.de/kommentare-in-c.html ->
"Es gibt noch einen weiteren Kommentar, nämlich /**. Dies ist formal für 
die Sprache nur ein /* Kommentar, dient aber verschiedenen Tools als 
Erkennung für einen Dokumentationskommentar:
/**
  main Funktion des Hello World Programms
  @author Jens Weller
  @version 1.1
  */
...
Hier können verschiedene Angaben zur Dokumentation gemacht werden, 
zeilen mit @bezeichner werden erkannt, und zum Beispiel von doxygen dann 
entsprechend in einer Dokumentation ausgeben."

[c.m. (Gast)]

kommt wahrscheinlich auf die IDE an, in wie weit kommentare als 
dokumentation ausgewertet werden können - und c(++) kenne ich nicht 
wirklich.

aber hier mal ein beispiel mit java in der netbeans IDE:
über einer methode muss nur "/**+RETURN" eingegeben werden, und die 
@-parameter werden automatisch erzeugt. dann kann man da noch bla/blubb 
dokumentation zu schreiben, und wenn man die methode irgendwo verwendet 
bekommt man die dokumentation angezeigt.
außerdem kann man die gesamte dokumentation über "generate javadoc" 
exportieren und "anderweitig verwenden".
sehr nützlich wenn man klassen aus einem projekt in einem anderen 
verwendet - zm beispiel wenn man irgendein drittanbieter framework in 
seinem eigenen programm benutzt.

[Jobst Q. (joquis)]

Obwohl ich von Doxygen noch nichts gehört hatte, mache ich das auch mit 
wichtigen Kommentaren, die in die Dokumentation einfließen sollen.

Häufiger aber mit dem Zeilenkommentar: //**

Mit fgrep "/**" bekomme ich dann einen Extrakt aus dem Quelltext, der 
die wichtigsten Infos enthält.

[Sheeva P. (sheevaplug)]

Roman K. schrieb:
>

> /**
>    \defgroup util_setbaud <util/setbaud.h>: Helper macros for baud rate 
> calculations
>    \code
>    #define F_CPU 11059200
>    #define BAUD 38400
>    #include <util/setbaud.h>
>    \endcode
>

>
> Was hat es mit den Slash und den zwei Sternchen auf sich?

Das ist ein Kommentar , der für automatische Dokumentationswerkzeuge wie 
das bereits erwähnte Doxygen, aber auch Javadoc, JSDoc oder Swift 
bestimmt ist. Diese Kommentare werden dann in die Quellcodedokumentation 
aufgenommen, und mit den speziellen Tags darin (\defgroup, \code etc.) 
kann man den Kommentar obendrein auch noch ordentlich formatieren.

[Wolfgang (Gast)]

Jobst Q. schrieb:
> Obwohl ich von Doxygen noch nichts gehört hatte, mache ich das auch mit
> wichtigen Kommentaren, die in die Dokumentation einfließen sollen.
>
> Häufiger aber mit dem Zeilenkommentar: //**
>
> Mit fgrep "/**" bekomme ich dann einen Extrakt aus dem Quelltext, der
> die wichtigsten Infos enthält.

Dann sollest du dir Doxygen mal ansehen. Damit kannst du dir viel 
(Hand-)Arbeit sparen.
https://de.wikipedia.org/wiki/Doxygen

[jz23 (Gast)]

/** oder /// werden häufig für Dokumentationen benutzt. Häufig Doxygen 
oder um IntelliSense in Visual Studio zu benutzen. Außerdem wird es auch 
benutzt, um Kommentare als Dokumentation zu kennzeichen, auch wenn keine 
Tools dafür genutzt werden.

[Jörg W. (dl8dtl) (Moderator)]

Da es in diesem Falle ein Stück aus der avr-libc ist, kann ich mit
autoritativer Sicherheit sagen, dass es für Doxygen so gemacht ist. ;-)