Поиск отсутствующего содержимого комментариев XML с помощью Visual Studio

Во всем исходном коде C # у нас есть много комментариев, в которых отсутствует фактическое содержание, например:

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

или это:

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

или это:

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

К сожалению, Visual Studio не выдает предупреждений об этом типе отсутствующих комментариев. Но для нас было бы хорошо, если бы мы могли просто щелкнуть элемент в списке (например, список предупреждений) внутри Visual Studio, а затем попасть в неисправное место в исходном коде, чтобы исправить его. Также было бы неплохо видеть список отсутствующего содержимого комментариев xml при каждой сборке файлов xml. У вас есть идеи, как этого добиться?


visual-studio xml-comments
person bitbonk    schedule 05.11.2008    source источник

Ответы (4)


arrow_upward
7
arrow_downward

Попробуйте средство проверки комментариев XML:

XML Comment Checker - это приложение, которое проверяет документацию XML для сборки .Net на предмет упущений. Он предлагает более полную проверку, чем сам компилятор C #, и идеально подходит для тех случаев, когда вы хотите проверить свои комментарии перед их компиляцией в настоящую документацию, например, с помощью Microsoft Sandcastle.

Из списка функций:

Проверьте наличие пустых разделов. При необходимости средство проверки комментариев XML выдаст предупреждение, если какие-либо из требуемых разделов или элементов присутствуют, но являются пустыми. По умолчанию это не включено

Использование из Visual Studio:

Средство проверки комментариев XML можно настроить как событие после сборки в Visual Studio для автоматической проверки сборки. Предупреждения, выдаваемые программой проверки комментариев XML, отформатированы таким образом, чтобы Visual Studio распознала их и отобразила в списке ошибок. Пример командной строки после сборки: "PathToCommentChecker \ CommentChecker.exe" "$ (TargetPath)" -nologo -warnemptysections

person xsl    schedule 05.11.2008
comment
Несмотря на то, что сообщения отображаются в списке предупреждений в Visual Studio, невозможно щелкнуть предупреждение, чтобы перейти к местоположению исходного кода. - person bitbonk; 05.11.2008
comment
Это невозможно, потому что XML Commentchecker использует сборку и сгенерированный файл XML-документа, а не исходный исходный код. - person bitbonk; 05.11.2008

arrow_upward
5
arrow_downward

ReSharper - это ответ на этот (как и многие другие) недостатки Visual Studio. Мне только жаль всех, кто им не пользуется. ;)

person bitbonk    schedule 21.05.2010

arrow_upward
1
arrow_downward

FxCop и настраиваемое правило?

person bob    schedule 05.11.2008

arrow_upward
0
arrow_downward

Вы можете использовать файл XSLT и отлаживать xml по файлу XSLT, и тогда он выдаст ошибку, если 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>
person ANIL KHANDEI    schedule 28.01.2016