Che problemi dovrei avere se utilizzo Smart :: Comments in development code?

Question

Comprendo che Smart :: Comments non deve essere utilizzato nel codice di produzione, poiché si tratta di un filtro di origine.

Tuttavia, ho utilizzato Smart::Comments nel mio codice di sviluppo e quindi commentando la riga "use" prima di inviare il codice alla produzione.

Dato che lo userò nel mio codice di sviluppo, di cosa dovrei preoccuparmi in particolare? Ho cercato su Internet e non ho trovato motivi per cui dovrei essere preoccupato, tranne che i filtri di origine sono "una cattiva idea" o "cattiva" o che non dovrebbero mai essere usati nel codice di produzione.

UPDATE: Ora sto utilizzando una chiave vincolante nel vim per implementare l'approccio di Sinan Unur:

map <Leader>c <Esc>:!perl -MSmart::Comments %<CR> 

Answer 1

filtri Source sono male problematico perché utilizzano un parser imperfetta di riscrivere il codice. Tutto funziona alla grande, purché il filtro gestisca il codice che lo alimenta.

Nel momento in cui aggiungi qualcosa che rompe il filtro, l'intero sistema si autodistrugge e ottieni bug bizzarri.

I filtri di origine confondono anche il debugger, che può essere un problema - se si utilizza il debugger.

Answer 2

Non ho un'opinione sulla parte dei filtri di origine. Ma guarda la sinossi di Smart::Comments. Potrebbero essere intelligenti, ma quello che si finisce non può essere definito "commenti". Se hai bisogno di una barra di avanzamento, vai avanti, aggiungine uno esplicitamente. Se hai bisogno di commentare qualcosa, fallo in modo che sia il prossimo a leggere la tua fonte per capire cosa intendi.

Answer 3

Smart :: Commenti è appositamente scritto in modo tale che quando si commenta "use Smart :: Comments" si tratterebbe solo di commenti, quindi il programma non è interessato. Altri moduli hanno problemi più seri, come quando non sarai in grado di ottenere il numero esatto di errori.

Answer 4

preferisco non mettere:

use Smart::Comments; 

nel mio codice. Quando ho usate davvero Smart::Comments, invoco lo script utilizzando:

$ perl -MSmart::Comments test.pl 

In questo modo, non v'è alcuna possibilità Smart::Comments saranno utilizzati nel codice di produzione.

Answer 5

Sono un grande fan di Smart :: Comments, e viene chiamato in tutto il nostro codice, sviluppo e copie di produzione. Raramente lo uso per le barre di avanzamento, principalmente per asserzioni e output di debug.

Tuttavia, la pratica è quello di tirare in utilizzando il modulo:

use Smart::Comments -ENV; 

Se i Smart_Comments variabile d'ambiente non è impostata, intelligente :: commenti è completamente inerte.

Il meglio di entrambi i mondi.