mikrocontroller.net

Forum: PC-Programmierung Doxygen; Lokale Variablen


Autor: Frank S. (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
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:
/**
  @ingroup  test
  @var      GlobaleVar
  @brief    Eine globale Variable für Doxygen
*/
unsigned int GlobaleVar = 0; 


/**
   @ingroup     test    
   @brief       Eine tolle Rechnung         
   @param       ADC_Value  Letzter Messwert des ADC
   @return      Das Ergebnis einer hoch aufwändigen Rechnung...    
*/
unsigned int Calculate(unsigned int ADC_Value)
{
  
  /** @brief Beschreibung von TempVar */
  unsigned char TempVar = 0; 
        TempVar = ADC_Value + GlobaleVar;
        // mache noch irgendwas sinnvolles mit TempVar 
        return TempVar;
}


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:
///Beschreibung von TempVar 
unsigned char TempVar = 0; 


/** Beschreibung von TempVar */
unsigned char TempVar = 0; 


/**
  @var TempVar
  @brief Beschreibung von TempVar
*/
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

: Verschoben durch Admin
Autor: Frank S. (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
???

Autor: StinkyWinky (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Frank S. schrieb:
> Wie beschreibt man lokale Variablen Doxygen-gerecht?????

Soviel ich weiss, geht das nicht mit Doxygen.

Autor: woswasi2011 (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
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

Autor: Michael K. (michael_k74)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Hallo.

Hat schon jemand eine Antwort auf die Frage gefunden? Ein Workaround 
wäre auch o.K..

Autor: Karl Heinz (kbuchegg) (Moderator)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
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)

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

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

Autor: Frank Meier (aktenasche)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
jeder nachfolgende entwicklet wird sich freuen wenn die doku um etwa 
1000% anschwillt wenn man noch lokale variablem mit reinpackt...dafür 
sind kommentare da

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.
Hinweis: der ursprüngliche Beitrag ist mehr als 6 Monate alt.
Bitte hier nur auf die ursprüngliche Frage antworten,
für neue Fragen einen neuen Beitrag erstellen.

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