avviso di soppressione per codice C# generato

Question

Ho attivato "Considera gli avvertimenti come errori" per il mio progetto VS, il che significa che ottengo errori per la documentazione mancante (promemoria per questo particolare progetto).

Tuttavia, parte del codice è generata da uno strumento personalizzato che non inserisce la documentazione xml, quindi sto cercando di ignorare la documentazione xml mancante solo per il codice generato, non per l'intero progetto. Non ho alcuna influenza sul file effettivo generato e non posso realmente inserire nulla nel file (poiché viene rigenerato frequentemente dallo strumento), quindi cerco qualcosa di esistente al di fuori del file generato (le classi generate sono parziali, se questo aiuta)

Answer 1

MODIFICA: vedere i commenti che indicano che questo non funziona con C# 4. Non sono chiaro se ha funzionato nelle versioni precedenti del compilatore. La specifica C# 4 lo rende piuttosto chiaro. Sezione 2.5.8.1 afferma:

Una direttiva #pragma warning restore ripristina tutto o il dato insieme di avvertimenti allo stato in cui era in vigore all'inizio della unità di compilazione. Si noti che se un avviso particolare è stato disabilitato esternamente, un #pragma warning restore (se per tutti o l'avviso specificato) non riattiverà tale avviso.

Jeff ha un workaround in a blog post - fondamentalmente per rielaborare il codice generato automaticamente come parte del build.

---

Come dice Tom, è possibile aggiungere un "ignora" per l'intero progetto (Build/eliminare gli avvisi - digitare 1591 come numero di avvertimento) - ma allora si può ripristinare il te stesso avviso nella parte superiore della ciascuno dei vostri file non generati:

#pragma warning restore 1591 

E 'abbastanza brutto, ma funziona (ho appena provato).

Answer 2

Il meglio che si può fare in questo è sopprimere il particolare avviso nel progetto che contiene il codice generato. Puoi farlo in Proprietà progetto nella scheda Costruisci. Non è l'ideale, ma a parte mettere il pragma nel codice generato, è il meglio che puoi fare.

Answer 3

Il modo migliore per evitare di avere avvisi o errori di analisi del codice su codice generato è quello di decorare le vostre classi generate con il GeneratedCodeAttribute e rendere il file di codice termina con il modello * .generated.cs.

Se i file di codice hanno anche un'intestazione del file, si dovrebbe avuto questi tag:

//---------------------- 
// <auto-generated> 
//  Tool description 
// </auto-generated> 
//---------------------- 

Questo non è obbligatorio, ma se si dispone di intestazione del file di codice è una buona pratica.

In questo modo, FxCop e altri strumenti come StyleCop non analizzeranno più il codice.

Ciò che è anomalo è che lo strumento di generazione del codice non decortica gli elementi del codice con l'attributo menzionato sopra. Cerca di verificare se è disponibile un'opzione da attivare nelle impostazioni dello strumento o contatta il team di sviluppo.

---

EDIT: fa le classi generate sono classi parziali e fare il nome effettivo classi e il numero cambia spesso? Perché se il contenuto del codice generato non si sta muovendo molto, quello che puoi fare è semplicemente creare un altro file di codice e dichiarare semplicemente la classe parziale generata per decorarli con GeneratedCodeAttribute. Una volta mi ha salvato la vita (e il mio tempo!).