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

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

7 голосов
/ 05 ноября 2008

Во всем или исходном коде C # у нас есть много комментариев, которые пропускают реальный контент, такой как это: 

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

или это: 

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

или это: 

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

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

Ответы [ 4 ]

7 голосов
/ 05 ноября 2008

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

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

Из списка возможностей:

Проверить наличие пустых секций. Опционально, XML Comment Checker предупредит, если таковые имеются необходимых разделов или элементов присутствуют, но пусто. Это не по умолчанию включено

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

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

5 голосов
/ 21 мая 2010

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

1 голос
/ 05 ноября 2008

FxCop и пользовательское правило?

0 голосов
/ 28 января 2016

Вы можете использовать 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>
...