7

全体またはC#ソースコードには、次のような実際のコンテンツを見逃しているコメントがたくさんあります。

/// <summary>
/// </summary>

またはこれ:

/// <summary>
///
/// </summary>

またはこれ:

/// <param Name="flag"></param>

残念ながら、Visual Studioは、このタイプの欠落したコメントに対して警告を生成しません。しかし、私たちにとっては、Visual Studio内のリスト(警告リストなど)内のアイテムをクリックして、ソースコード内の誤った場所に移動して修正できれば便利です。また、xmlファイルのビルドごとに欠落しているxmlコメントコンテンツのリストを確認すると便利です。これを達成する方法について何か考えがありますか?

4

4 に答える 4

7

XML コメント チェッカーを試す:

XML Comment Checker は、.Net アセンブリの XML ドキュメントに抜けがないかチェックするアプリケーションです。これは、C# コンパイラ自体よりも包括的なチェックを提供し、コメントを実際のドキュメントにコンパイルする前に、たとえば Microsoft Sandcastle を使用してチェックしたい場合に最適です。

機能リストから:

空のセクションを確認します。必要に応じて、XML コメント チェッカーは、必要なセクションまたは要素が存在するが空である場合に警告します。これはデフォルトでは有効になっていません

Visual Studio からの使用:

XML コメント チェッカーを Visual Studio のビルド後のイベントとして設定して、アセンブリを自動的にチェックできます。XML コメント チェッカーによって出力される警告は、Visual Studio が認識してエラー一覧に表示できるようにフォーマットされています。ビルド後のコマンド ラインの例: "PathToCommentChecker\CommentChecker.exe" "$(TargetPath)" -nologo -warnemptysections

于 2008-11-05T08:48:06.100 に答える
5

ReSharper は、この (他の多くの) Visual Studio の欠点に対する答えです。使わない人がいて残念です。;)

于 2010-05-21T12:45:35.803 に答える
1

FxCopとカスタムルール?

于 2008-11-05T08:46:27.647 に答える
0

XSLT ファイルを使用し、XSLT ファイルに対して xml をデバッグすると、xml が適切に形成されていない場合はエラーがスローされ、xml が適切に形成されていない正確な行番号が表示されます。この単純な XSLT ファイルは動作します-

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
    xmlns:msxsl="urn:schemas-microsoft-com:xslt" exclude-result-prefixes="msxsl"
>
    <xsl:output method="xml" indent="yes"/>

    <xsl:template match="@* | node()">
        <xsl:copy>
            <xsl:apply-templates select="@* | node()"/>
        </xsl:copy>
    </xsl:template>
</xsl:stylesheet>
于 2016-01-28T01:38:02.020 に答える