2011-09-07 5 views
44

mie squadre C-scrivere il codice che sarebbe meglio per posizionare un '<' in un commento come illustrato di seguito:Perché un commento C come/* */necessita '<'? linee guida

#define MAX_PACK_ITEM_NUM 50 /**< max number of item */ 

Mi chiedo, qual è il vero uso di questo '<'?

+0

Erm, come una freccia? È un commento, quindi non c'è nessuno qui che sarà in grado di rispondere. –

+46

Qual è la risposta dal tuo team? – Henrik

+13

Perché le persone vogliono chiudere questo? È una domanda perfettamente valida! –

risposta

73

È un modo per doxygen generare documentazione per i membri di un file/struct/union/class/enum. Usando quel marcatore, puoi inserire commenti dopo ogni membro, portando a meno confusione. Potete leggere di più su di esso here.

10

Presumo che il team utilizzi uno strumento di documentazione automatizzata che cerca /**<; per esempio. Doxygen.

+6

Doxygen ad esempio utilizza queste parentesi angolari per descrivere membri ecc. – arne

17

È un doxygen syntax per i membri commentatori dopo la dichiarazione/definizione.

45

Come altri hanno risposto, questo è probabilmente un commento destinato a doxygen. Durante l'analisi commenti, doxygen avere alcune regole speciali:

  • Un commento ordinari a partire con /* è ignorato da doxygen.
  • Un commento che inizia con /** viene considerato come documentazione del elemento successivo dopo il commento nel codice sorgente.
  • Un commento che inizia con /**< viene considerato come documentazione dell'articolo immediatamente prima del il commento nel codice sorgente.

La documentazione viene in genere posizionata sopra l'articolo documentato, ad es. una funzione. In alcuni casi, ad esempio #define, è consigliabile inserire la documentazione alla fine della riga e in tal caso è necessario il contrassegno /**<.