2014-05-07 23 views
7

In vim, ogni volta che aggiungere un commento come questoXXX in C++ commenti

int somevar = 100; //XXX Some Comment Here

La parte "XXX" del mio commento viene evidenziato automaticamente. Anche "TODO" in un commento viene evidenziato in modo simile. Li ho usati abbastanza ampiamente per marcare ogni cosa/attirare l'attenzione, ma non mi sono mai preso la briga di imparare cosa rende speciale "XXX" e "TODO". Cosa rende speciali queste due parole?

Ci sono altre parole speciali nei commenti che vengono automaticamente evidenziate?

+1

Vedere anche http://stackoverflow.com/a/7284583/314291 – StuartLC

risposta

5

Questi sono resi speciali dai file di sintassi che Vim si affida allo stile all'interno di un codice sorgente.

Per esempio sulla mia macchina, file seguente sintassi predefinita per C, (che è di provenienza da C++ file di sintassi troppo), contiene il file linea di

: /Applications/MacVim.app/Contents/Resources/vim/ runtime/sintassi/c.vim

syn keyword  cTodo   contained TODO FIXME XXX 

colori e styling per cTodo, se si cerca verrebbe definito all'interno c.vim file.

Per C++ il nome del file è cpp.vim, che le fonti (include) c.vim

Perché queste parole chiave?
Io non ho studiato molto, ma i programmatori hanno iniziato a mettere in risalto i loro commenti, in modo che loro (o qualcun altro) possano arrivare a quell'area di codice in un secondo momento (per qualsiasi motivo, come affermato nel commento). Gli editori, come Vim, lo hanno notato e hanno aggiunto l'evidenziazione della sintassi per questi prefissi per renderli ancora più evidenti.

A questo proposito, la maggior parte degli editori oggi ha modificabile sintassi (o personalizzabile). È possibile aggiungere le proprie parole chiave che si desidera evidenziare nei commenti! (anche per altre parole chiave/token).

5
  • TODO per indicare i miglioramenti previsti.
  • XXX per avvisare altri programmatori di codice problematico o errato.

Source.