Discussion :

[JPras]

Bonjour à toutes et à tous,

on m'a donner du code à documenter via DOXYGEN or je n'arrive pas à documenter des variables déclarées au sein d'un fonction, je m'explique:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/**
* \brief lit un octet à une adresse donnée
* \details
*          fonction blaquante : attente jusqu'à la
 *         fin de la réception de la donnée
* \param i2cSlaveAddress
* \param i2cSlaveRegister
* \return i2cData
*
*/
char I2C_ReadByte(char i2cSlaveAddress, char i2cSlaveRegister)
{
 
    unsigned char i2cData; /*!< \var To Do*/
    // initiate start condition
    SSP1CON2bits.SEN = 1;
    __delay_us(1);
}

Je ne comprend pas pourquoi mais le commentaire "To Do" s'afiche à la suite de la fonction et i2cData n'est pas reconnue comme une variable.

Une idée svp ??

Merci d'avance

[Neckara]

Bonjour,

Si tu dois commenter l'intérieur d'une fonction, c'est que généralement, tu as un problème dans ton code, d'autant plus si cela concerne une variable.
Un code explicite ne devrait pas avoir besoin de commentaires et encore moins de commentaires doxygen.

Mettre des commentaires doxygen à une variable d'une fonction n'a strictement aucun sens et même aucune utilité.

[Médinoc]

Neckara a raison sur un point, Doxygen n'est pas censé documenter l'intérieur d'une fonction, seulement son interface et son utilité (en gros, ce qu'on expose aux utilisateurs du code).
Pour documenter le code à l'intérieur d'une fonction, les commentaires normaux suffisent.