سؤال

في التعليمات البرمجية أدناه في وثائق XML، هناك عدم تطابق بين أسماء المعلمات في حجج الأسلوب واسم المعلمات في وثائق XML. هل هناك أي طريقة لتصحيح توقيع مستندات XML أو أي ميزة موجودة في RESHHARPER إلى تلقائي تصحيح وثائق XML.

#region Get Images

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages()
{
    return GetImages("");
}

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(string imageType)
{
    return GetImages(0, imageType);
}

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(int imageId)
{
    return GetImages(imageId, "");
}

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(int imageId,string imageType)
{
    return null;
}

#endregion

على سبيل المثال، أريد أن تكون الطريقة مع وثائق XML مثل هذا:

/// <summary>
///  Get Images 
/// </summary>
/// <param name="imageId"></param>
/// <param name="imageType"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(int imageId,string imageType)
{
    return null;
}

#endregion
هل كانت مفيدة؟

المحلول

سوف ghostdoc القيام بذلك من أجلك. بعد التثبيت، تحصل على عنصر قائمة سياق جديد في مستند VS "(واختصار لوحة المفاتيح المقابلة).

إذا لم يتم تقديم تعليقات XML، فسوف يضيفها. إذا كانت موجودة بالفعل، فيجب تحديثها كما تحتاج.

http://submain.com/products/ghostdoc.aspx.

نصائح أخرى

الطريقة الوحيدة التي أعرفها "تصحيح تلقائي" XML مع R # هي حذف وثائق XML الحالية وضرب /// مرة أخرى. آسف ليس لدي إجابة أفضل.

أعتقد أنه غير ممكن لأن R # لا يحتاج إلى تصحيح مستندات XML أو توقيع الأسلوب.

مرخصة بموجب: CC-BY-SA مع الإسناد
لا تنتمي إلى StackOverflow
scroll top