Visual Studioで不足しているXMLコメントコンテンツを見つける
-
06-07-2019 - |
質問
スルーアウトまたはC#ソースコードには、次のような実際のコンテンツを見逃すコメントがたくさんあります。
/// <summary>
/// </summary>
またはこれ:
/// <summary>
///
/// </summary>
またはこれ:
/// <param Name="flag"></param>
残念ながら、Visual Studioはこのタイプのコメントの欠落について警告を生成しません。しかし、私たちにとっては、Visual Studio内のリスト(たとえば、waringsリスト)のアイテムをクリックして、ソースコードのエラーのある場所に移動して修正できると便利です。また、xmlファイルをビルドするたびに、欠落しているxmlコメントコンテンツのリストを見るといいでしょう。これを達成する方法についてのアイデアはありますか?
解決 2
ReSharperは、Visual Studioのこの(他の多くの)欠点に対する答えです。私はそれを使わない人には哀れしかありません。 ;)
他のヒント
XMLコメントチェッカーを試してください:
XMLコメントチェッカーはアプリケーションです XMLドキュメントをチェックします 省略のための.Netアセンブリの場合。それ より包括的なチェックを提供します C#コンパイラ自体よりも あなたがチェックしたいときに最適です コンパイルする前のコメント 実際のドキュメント、例えば Microsoft Sandcastle。
機能リストから:
空のセクションを確認します。オプションで、 XMLコメントチェッカーがあれば警告します 必要なセクションまたは要素の 存在しますが、空です。これではありません デフォルトで有効になっています
Visual Studioの使用法:
XMLコメントチェッカーは、 Visual Studioのビルド後イベント アセンブリを自動的に確認します。 XMLコメントによって出力される警告 チェッカーは次のようにフォーマットされています Visual Studioはそれらを認識します エラーリストに表示します。あ ビルド後のコマンドラインの例: &quot; PathToCommentChecker \ CommentChecker.exe&quot; &quot; $(TargetPath)&quot; -nologo -warnemptysections
FxCop とカスタムルール
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>