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

StackOverflow https://stackoverflow.com/questions/264623

  •  06-07-2019
  •  | 
  •  

Вопрос

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

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

или это: 

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

или это: 

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

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

Это было полезно?

Решение 2

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

Другие советы

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

  

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

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

  

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

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

  

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

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

Вы можете использовать файл 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>
Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top