2012-11-12 15 views
5

Sto guardando un esempio di codice doxygen e vedo quanto segue.

/** 
    @file test.h 
    @brief Define helper functions 
    $Id: test.h,v 1.10 2012/10/10 10:10:10 author Exp $ 
*/ 

Qualcuno può spiegare che cosa $ Id: fare qui?

Grazie

+0

Hmm. Quel ', v' sembra sospettosamente come un identificatore di file CVS. Non ho usato CVS per anni e anni, quindi non ho ancora nessun repository da controllare! Date un'occhiata all'inizio di [questo file] (ftp://ftp-glast.slac.stanford.edu/glast.u05/src/CMX/cmt/cmx_doxygen.pl) per un esempio simile. – Rook

+3

Questo è un id controllo di versione, CVS, SVN o altro. Il meccanismo di controllo della versione aggiornerebbe automaticamente tali informazioni quando si eseguono alcune modifiche. Né è specifico per Doxygen. – juanchopanza

risposta

10

Questa non è una linea doxygen. Questo è un carattere di comando di controllo del codice che gli dice di sostituire le informazioni sulla versione in modo da poter vedere nell'origine quale versione impegnata stai lavorando. Vedi http://www.badgertronics.com/writings/cvs/keywords.html

+0

Quindi aggiungo '$ Id: $' prima di importare i miei file nel repository? Grazie – elgnoh

+0

La sintassi '$ Id: $' viene utilizzata da RCS, CVS e (facoltativamente) SVN. Sì, aggiungi '$ Id: $', o solo '$ Id $', al tuo file sorgente prima di controllarlo; controllarlo automaticamente lo espande. –

+0

Potrebbe anche essere necessario dire manualmente al sistema di controllo del codice sorgente di effettuare la sostituzione delle parole chiave affinché inserisca queste informazioni nel tag. per esempio. per SVN vedere (http://wiki.preshweb.co.uk/doku.php?id=svn:propset)[http://wiki.preshweb.co.uk/doku.php?id=svn:propset] qualcosa come "svn propset svn: keywords 'Id' test.h" Puoi anche configurarlo nella sezione [auto-prop] del tuo file .subversion/config per aggiungere atutomaticamente questa proprietà ai nuovi file, con linee come "* .h = svn: keywords = Id " –