مساحة الوثائق على .صافي المشروع (الرمال)?

Question

لقد بدأت باستخدام الرمال منذ بعض الوقت لإنشاء وثائق موقع واحد من مشاريعنا.إنه يعمل بشكل جيد جدا ولكن كنا دائما فقط وثائق مكتوبة عن فئات أساليب وخصائص (...) في مشروعنا و قد منفصلة تماما الوثائق العامة للمشاريع أجزاء/modules/مساحات الأسماء.سيكون لطيفا إذا كنت يمكن دمج هذه الوثائق معا و إضافة كل الوثائق التي تم إنشاؤها مساعد الملفات ولكن أنا لا يمكن معرفة كيفية القيام بذلك.

فقط إضافة تعليقات إلى مساحة الإعلان لا يبدو أن العمل (C#):

/// <summary>
/// My short namespace description
/// </summary>
namespace MyNamespace { ... }

لا أحد يعرف كيفية القيام بذلك ؟ أنا أعلم أنه من الممكن بطريقة ما و سيكون من الجميل حقا أن يكون...:)

Answer 1

كما يدعم

والقلعة الرملية وثائق مساحة الاسم على غرار ndoc، والذي يسمح لك التمسك الوثائق في الملفات المصدر:

وببساطة إنشاء فئة غير عامة تسمى NamespaceDoc في مساحة الاسم الذي تريد توثيق، وأكس ثيقة تعليق على تلك الفئة سيتم استخدامها لمساحة الاسم.

وتزين ذلك مع [CompilerGenerated] سمة لمنع الفئة نفسها من الظهور في وثائق.

مثال:

namespace Some.Test
{
    /// <summary>
    /// The <see cref="Some.Test"/> namespace contains classes for ....
    /// </summary>

    [System.Runtime.CompilerServices.CompilerGenerated]
    class NamespaceDoc
    {
    }
}

ويقع عنصر العمل في القلعة الرملية rel="noreferrer">

Answer 2

إذا كنت تستخدم القلعة الرملية مساعدة ملف باني هناك حوار لدخول ملخصات النطاق. (على ما يبدو أيضا دعم لتحديد فئة معينة، ولكن أود أن لا تفضل ذلك ..)

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

<اقتباس فقرة>   

وتعريف موجز المشروع و   تعليق موجز مساحة الاسم الذي سوف   تظهر في ملف المساعدة. بامكانك ايضا   تشير بسهولة ومساحات ل   تضمين أو استثناء من ملف التعليمات.   كما يتم تضمين الدعم ل   تحديد تعليقات مساحة الاسم عبر   الطبقة NamespaceDoc داخل كل   مساحة الاسم.

Answer 3

استخدام Sandcastle ملف المساعدة باني.فإنه يسمح لتحديد مساحة الأوصاف في XML ملف المشروع

على سبيل المثال:

<namespaceSummaryItem name="System" isDocumented="True">
    Generic interfaces and helper classes.
</namespaceSummaryItem>

المراجع:

• مثال على مشروع مفتوح المصدر أن يولد الوثائق مع كل بناء (كل النصوص في الجذع).
• هذا كيف الوثائق من قبل SHFB يبدو على شبكة الإنترنت (ذلك يتم نشرها على كل القسري بناء)

.

Answer 4

وأنا أعلم أنه في آخر العمر، ولكن هذا قد يكون عونا لشخص آخر.

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

<اقتباس فقرة>   

لتحرير ملخصات مساحة الاسم، قم بتوسيع القسم ملخصات ضمن علامة التبويب خصائص المشروع في SHFB. سترى إعداد الكشف عن اسمه، "NamespaceSummaries"، مما يدل في البداية قيمة "(لا يوجد)". انقر فوق الإعداد لتحديده وزر يظهر رمز القطع (...) تظهر. انقر فوق هذا الزر لعرض مربع الحوار النطاق ملخصات، في الصورة أدناه:

Answer 5

وأنت غير قادر على إضافة مراجع بهذه الطريقة - القيام بذلك عن طريق NamespaceDoc.cs الحالات

وأي بمعنى

و/// <summary> /// Concrete implementation of see cref="IInterface" using see cref="Concrete"
/// </summary> class NamespaceDoc { }

نرى هنا

Answer 6

وأنا راجع وثائق ل"XML الخارجي التعليقات الملفات". عرض مخطط مثل:

<doc>
    <assembly/>
    <members>
        <member/>
    </members>
</doc>

إذا هذا يتم وضعها في ملف منفصل، ما من شأنه أن يكون التمديد (XML / مكافحة غسل الأموال) وهذا يمكن أن تستخدم في مشروع Visual Studio؟