Doxygen; Lokale Variablen

Gast #1902509
Hallo allerseits,

mit Doxygen arbeite ich nun schon seit geraumer Zeit und bin eigentlich 
auch sehr zufrieden damit. Nur eine Sache hab ich bisher nie 
hinbekommen: das dokumentieren von lokalen Variablen.

Ein kl. Beispiel:
1
/**
2
  @ingroup  test
3
  @var      GlobaleVar
4
  @brief    Eine globale Variable für Doxygen
5
*/
6
unsigned int GlobaleVar = 0; 
7

8

9
/**
10
   @ingroup     test    
11
   @brief       Eine tolle Rechnung         
12
   @param       ADC_Value  Letzter Messwert des ADC
13
   @return      Das Ergebnis einer hoch aufwändigen Rechnung...    
14
*/
15
unsigned int Calculate(unsigned int ADC_Value)
16
{
17
  
18
  /** @brief Beschreibung von TempVar */
19
  unsigned char TempVar = 0; 
20
        TempVar = ADC_Value + GlobaleVar;
21
        // mache noch irgendwas sinnvolles mit TempVar 
22
        return TempVar;
23
}


Das dokumentieren der globalen Variablen funktioniert in diesem Beispiel 
tadellos. Das Doxygen-gerechte dokumentieren der lokalen Variable 
TempVar klappt aber absolut nicht.

Bisher hab ich u.a. noch zusätzlich folgende Variante probiert, jeweils 
innerhalb der Funktion:
1
///Beschreibung von TempVar 
2
unsigned char TempVar = 0; 
3

4

5
/** Beschreibung von TempVar */
6
unsigned char TempVar = 0; 
7

8

9
/**
10
  @var TempVar
11
  @brief Beschreibung von TempVar
12
*/
13
unsigned char TempVar = 0;


Nichts davon funktioniert. Wie macht ihr das? Wie beschreibt man lokale 
Variablen Doxygen-gerecht?????

Vielen Dank für alle Antworten...

Gruß
Frank
Gast #2514718
Ist zwar schon etwas älter, aber eventuell gibts ja noch wen der das 
Problem hat und noch nicht gelöst hat

Alternativ kann man Variablen auch mit

uint8_t bla; //!< Variable für dieses und jenes

dokumentieren
#3137274
Die Frage, die ich mir stelle:
wozu will ich die lokale Variablen einer Funktion doxygen gerecht 
dokumentieren?

Die Variablen sind nur innerhalb der Funktion interessant, ausserhalb 
dieser Funktion benötigt sie niemand. Also brauch ich auch keine 
aufbereitete Doku dazu, denn ohne den zugrundeliegenden Algorithmus, 
sind die aus Projektsicht komplett uninteressant. Sie sind ein 
Implementierungsdetail der Funktion selber, welches sich ausserhalb der 
Funktion in keiner weise auswirkt (auswirken sollte)

1
  /** @brief Beschreibung von TempVar */
2
  unsigned char TempVar = 0;

nenn das Ding nicht TempVar sondern nenne es entsprechend seiner 
Funktion, dann ist das Dokumentation genug.

Antwort schreiben

Eine eigene Frage? Dieser Thread ist über 16 Jahre alt. Stell sie in einem eigenen Thread – dort lesen mehr Leute mit, und sie wird öfter und schneller beantwortet.

Neuen Thread starten

Eine Lösung, Ergänzung oder Rückmeldung zu diesem Thread? Dann antworte hier.

Formatierung
  • [c]C-Code[/c]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] – Link zu einem Artikel
  • Verweis auf einen anderen Beitrag: Rechtsklick auf dessen Beitrags-ID (#8078628), „Adresse kopieren“, in den Text einfügen

Mehr zur Formatierung

Längeren Sourcecode als Anhang, nicht in den Text. JPG nur für Fotos und Scans; Zeichnungen und Screenshots als PNG oder GIF. Siehe Bildformate.

Schon registriert? Anmelden

Wird nicht angezeigt. Wir schicken dir einen Link; sobald du damit bestätigst, erscheint dein Beitrag.

Mit dem Abschicken legst du einen kostenlosen Account an und erkennst die Nutzungsbedingungen und die Datenschutzerklärung an.