العثور على محتوى تعليقات XML المفقود باستخدام Visual Studio

Question

في جميع أنحاء الكود المصدري لـ C#، لدينا الكثير من التعليقات التي تفتقد المحتوى الفعلي مثل هذا:

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

أو هذا:

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

أو هذا:

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

لسوء الحظ، لا يقوم Visual Studio بإنشاء تحذيرات لهذا النوع من التعليقات المفقودة.ولكن بالنسبة لنا سيكون من الرائع أن نتمكن فقط من النقر على عنصر في القائمة (على سبيل المثال.قائمة التحذيرات) داخل الاستوديو المرئي ثم يتم نقلك إلى الموقع الخاطئ في الكود المصدري لتصحيحه.سيكون من الجيد أيضًا رؤية قائمة محتوى تعليقات XML المفقودة عند كل إنشاء لملفات XML.هل لديك أي فكرة عن كيفية تحقيق ذلك؟

Answer 1

وReSharper هو الحل لهذه (كما العديد من الآخرين) العيب من Visual Studio. ليس لدي أي شيء ولكن المؤسف لمن لا يستعمل ذلك. ؛)

Answer 2

يحاول مدقق تعليق XML:

XML Comment Checker هو تطبيق سيتحقق من وثائق XML لتجميع .NET للإغفالات.إنه يوفر فحصًا أكثر شمولاً من برنامج التحويل البرمجي C# نفسه ، وهو مثالي عندما ترغب في التحقق من تعليقاتك قبل تجميعها في وثائق حقيقية ، على سبيل المثال باستخدام Microsoft Sandcastle.

من قائمة الميزات:

التحقق من وجود أقسام فارغة. اختياريا ، سوف يحذر مدقق التعليق XML إذا كان أي من الأقسام أو العناصر المطلوبة موجودة ، ولكن فارغة.لا يتم تمكين هذا بشكل افتراضي

الاستخدام من Visual Studio:

يمكن تعيين مدقق التعليق XML كحدث ما بعد البناء في Visual Studio للتحقق من التجميع تلقائيًا. تم تنسيق التحذيرات المنبعثة من خلال مدقق التعليقات XML بحيث يتعرف عليها Visual Studio وعرضها في قائمة الأخطاء.مثال على سطر الأوامر بعد البناء:"PathTocommentChecker CommentChecker.exe" "$ (TargetPath)" -nologo -WarnemptySections

Answer 3

FxCop و قاعدة مخصصة؟

Answer 4

يمكنك استخدام ملف XSLT وتصحيح أكس ضد ملف XSLT وبعد ذلك سوف رمي الخطأ إذا لم يتم تشكيل جيدا أكس يظهر لك رقم السطر المحدد ضد والتي لا يتم تشكيل أكس جيدا. يعمل هذا الملف 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>