VS2010: automatisch generierte Dateien und XML-Dokumentation

Ist dies wirklich nur re-Fragen diese Frage zu Visual Studio 2008. Macht VS2010 bietet keine Funktion, um loszuwerden, das CS1591 compiler-Warnung für automatisch generierten code?

CS1591: Missing XML comment for publicly visible type or member

Zitieren, der die Frage für VS2008:

Dies ist ein ärgernis, mehr als ein
problem. Mein Projekt enthält eine Reihe
der automatisch generierte Dateien (mit
mgmtclassgen.exe-Datei). Wenn ich generieren
XML-Dokumentation, die, meine schön
kommentierte Bibliothek ist geplagt von xml
Dokumentation Warnungen aus diesen
autogen-Dateien.

Gibt es eine Möglichkeit, entweder a) zu unterdrücken
Generierung von Dokumentation für diese
Dateien oder b) unterdrücken warning CS1591
nur für einen Satz von Dateien? Ich natürlich
nicht zu ändernde Dateien
automatisch generierte, wenn auch nur hinzufügen
Unterdrückung pragmas.

BEARBEITEN:
In meinem Fall, die problematischen Dateien erstellt von WCF-RIA-Services, also die Datei, die generiert den Fehler die automatisch generierte WebContext-Klasse (MyProject.BusinessApplication.Web.g.cs).

Kann ich nicht von hand ändern, diese Datei dynamisch erstellt wird, werden alle änderungen gelöscht. Ich will auch nicht Global deaktivieren die Warnung, wie es ist hilfreich für meine nicht-automatisch generierte code.

InformationsquelleAutor Andrew Garrison | 2010-09-02
  1. 12

    Ich hatte ein ähnliches Problem mit auto-generated entity framework-Klassen. Ich konnte es lösen durch ändern der template-Datei. Dieser wird offensichtlich nicht Arbeit für alle auto-generierte Szenarien und es gelten möglicherweise nicht für Ihre spezielle RIA-Szenario, aber ich poste hier für jemand anderes, die möglicherweise mit dem gleichen Problem.

    Öffnen Sie die Vorlage-Datei (so etwas.tt) und finden Sie die automatisch generierte xml-Kommentar

    //------------------------------------------------------------------------------
//<auto-generated>
//   This code was generated from a template.
//
//   Manual changes to this file may cause unexpected behavior in your application.
//   Manual changes to this file will be overwritten if the code is regenerated.
//</auto-generated>
//------------------------------------------------------------------------------

    Fügen Sie die folgende Zeile direkt nach der Kommentar-block 

    #pragma warning disable 1591

    Etwas unter, dass, sollten Sie herausfinden, wo der namespace-block endet. Es wird wahrscheinlich so Aussehen

    if (!String.IsNullOrEmpty(ObjectNamespace))
{
    PopIndent();
#>
}

    Platzieren Sie die folgende Zeile nach, die schließende geschweifte Klammer

    #pragma warning restore 1591

    Wenn alles richtig geklappt hat, wenn Sie Ihre Klassen automatisch generiert werden, die von Entity Framework, sollten Sie gewickelt werden, durch das deaktivieren/wiederherstellen pragma-Anweisungen. Sollte dies unterdrücken der Warnungen über keine XML-Kommentare in Ihrem EF-Klassen, ohne Unterdrückung der Warnungen auf der Projekt-Ebene.

    InformationsquelleAutor Tallek
  2. 2

    Den folgenden Artikel auslösen kann Ihnen einige Tipps, um das Problem zu lösen: http://lvquoc.blogspot.com/2010/11/disable-xml-comment-warning-in-workflow.html

    Wichtigen Teil der Artikel ist der Kommentar von Alan McBee: für die Deaktivierung der Warnungen generiert, in windows workflow VS2012+ fügen Sie diese an der Unterseite des Projekt-Datei:

    <Target Name="XamlGeneratedCodeWarningRemoved" AfterTargets="MarkupCompilePass2">
  <Exec Command="for %%f in (@(_GeneratedCodeFiles)) do echo #pragma warning disable 1591 > %%f.temp" />
  <Exec Command="for %%f in (@(_GeneratedCodeFiles)) do type %%f >> %%f.temp" />
  <Exec Command="for %%f in (@(_GeneratedCodeFiles)) do echo #pragma warning restore 1591 >> %%f.temp" />
  <Exec Command="for %%f in (@(_GeneratedCodeFiles)) do move /y %%f.temp %%f" />
  <Message Text="Xaml Generated Code Warnings Removed: @(_GeneratedCodeFiles)" />
</Target>
    • sehr interessant,
    InformationsquelleAutor user526929
  3. 1

    Simmilarily zu Quam-Loc-Lösung ist es möglich, deaktivieren Sie die Warnungen in RIA generierten Dateien mit einem build-Ziel:

    <Target Name="CreateRiaClientFilesTaskDisableWarnings" AfterTargets="CreateRiaClientFiles">
  <Exec Command="for %%f in (@(RiaClientGeneratedFiles)) do echo #pragma warning disable &gt; %%f.temp" />
  <Exec Command="for %%f in (@(RiaClientGeneratedFiles)) do type %%f &gt;&gt; %%f.temp" />
  <Exec Command="for %%f in (@(RiaClientGeneratedFiles)) do attrib -r %%f" />
  <Exec Command="for %%f in (@(RiaClientGeneratedFiles)) do move /y %%f.temp %%f" />
  <Exec Command="for %%f in (@(RiaClientGeneratedFiles)) do attrib +r %%f" />
  <Message Text="CreateRiaClientFilesTaskDisableWarnings: @(RiaClientGeneratedFiles)" />
</Target>

    Ich habe gerade gebucht über Sie auf mein blog.

    InformationsquelleAutor Tomasz Pluskiewicz
  4. 0

    Ich Stand vor dem ähnlichen Problem. Was ich Tat, war, in welcher Seite, wenn es keine XML-Kommentare für den Namespace, nur fügen Sie die folgende Zeile code, und Sie nicht vor ähnlichen Fehler.

    '///<summary>
///Namespace provides implementation for ABC classes.
///</summary>
[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
class NamespaceDoc
{
}'
    InformationsquelleAutor Nayan_07
Schreibe einen Kommentar