È possibile configurare facilmente Doxygen per riconoscere le linee TODO e FIXME?

Question

Ho appena installato e la configurazione di un'istanza di Doxygen, ma fuori dalla scatola si trova distante solo tag TODO nel codice, quando ha segnato in un blocco come:

/** 
* @todo Foo 
*/ 

Non sembra trovare:

La maggior parte dei tracker di IDE e bug che gestiscono l'analisi sono soddisfacenti, esiste un modo semplice per configurare Doxygen per trovarli ed elencarli come elementi ToDo?

Answer 1

ci sono un certo numero di esempi e metodi che possiamo utilizzare:

• Per un commento di una riga con valida Doxygen comandi (ad esempio \todo) si usa

  /// \todo Some (optional) text 
  

  Nota i tre in avanti tagli, non i soliti due. Vedere il terzo punto della seconda lista nella sezione special documentation blocks della documentazione di Doxygen. Questo può essere usato per aggiungere nuovi oggetti todo al tuo codice sorgente.

• In genere è possibile definire tag personalizzati (come FIXME) definendo un alias nel file di configurazione di Doxygen. Per esempio

  ALIASES += FIXME="\todo" 
  

  che vi permetterà di scrivere \FIXME nel codice sorgente e le osservazioni con prefisso \FIXME saranno inclusi in voi todo list nella documentazione finale. Il problema qui è che devi anteporre i tuoi alias al simbolo \ (o @) e iniziare il commento con tre barre in avanti che, se vuoi lasciare le FIXME s nel tuo codice così come sono, non è un'opzione.

• Infine, un metodo alternativo, e quello che penso tu stia cercando, sarebbe quello di pre-elaborare i tuoi file sorgente usando l'opzione file di configurazione INPUT_FILTER. Questa opzione definisce un comando che viene applicato a ciascuno dei tuoi file sorgente prima che Doxygen costruisca la documentazione, così possiamo definire un comando che sostituisce le istanze di TODO e FIXME con una marcatura Doxygen valida.

  INPUT_FILTER = "sed -e 's/\/\/.*FIXME/\/\/\/ \\todo/'" 
  

  Questo filtro sostituisce tutte le istanze di // FIXME (con qualsiasi importo (o nessuno) di spazio tra // e FIXME) con /// \todo. Questa sostituzione viene eseguita internamente solo da Doxygen: i tuoi file sorgente non vengono modificati sul disco.

Nota: Questo ultimo punto è stato ispirato dalla risposta accettata alla domanda Getting Doxygen and MSVC TODO tags to work together. Tuttavia, tale risposta utilizzava l'opzione di configurazione FILE_VERSION_FILTER anziché INPUT_FILTER. Penso che quest'ultimo (INPUT_FILTER) sia effettivamente più appropriato qui. Inoltre, il comando sed utilizzato in quella risposta non funziona per me.