2008-11-05 31 views
6

縱觀或C#源代碼中我們有很多的未命中的實際內容,像這樣的評論:尋找失蹤的XML註釋

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

或本:

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

或這樣的:

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

不幸的是Visual Studio不會爲這類缺少的註釋產生警告。但是對於我們來說,如果我們可以在Visual Studio中敲擊列表中的項目(例如,warings列表),然後將其帶到源代碼中的錯誤位置來糾正它,那將會很好。另外,每次構建xml文件時都會看到缺少xml註釋內容的列表。你有什麼想法如何實現這一目標?

回答

5

ReSharper的是這個問題的答案(許多其他)的Visual Studio的缺點。對於任何不使用它的人,我只有憐憫。 ;)

7

嘗試XML Comment Checker

XML註釋檢查器是一個應用程序 將檢查XML文檔 用於.NET程序集的遺漏。它 提供了一個更全面的檢查 比C#編譯器本身,而且是 理想的,當你想彙編成 真正的文檔,使用e.g微軟 沙堡前檢查您的 意見。

從功能列表:

檢查空的部分。(可選) XML註釋檢查器將警告是否存在所需截面或元素 的任何 ,但是爲空。這不是 默認啓用從Visual Studio

用法:

XML註釋檢查器可裝配自動設置爲在Visual Studio中 生成後事件 檢查。 由XML Comment 發出的警告已被格式化,因此 Visual Studio會將它們識別爲和 將它們顯示在錯誤列表中。一個 例如生成後命令行: 「PathToCommentChecker \ CommentChecker.exe」 「$(TARGETPATH)」 -nologo -warnemptysections

+0

Allthough的消息出現在Warings列表這個簡單的XSLT文件在Visual Studio中,不可能點擊一個華林跳轉到源代碼的位置。 – bitbonk 2008-11-05 09:41:58

0

您可以使用XSLT文件和調試對XSLT文件的XML,然後如果XML的格式不正確顯示你針對的XML格式不正確形成確切的行號,它將引發錯誤。 工程─

<?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>