PDA

View Full Version : سوال: افزودن توضیح به متدهای ساخته شده در dll



ordebehesht
سه شنبه 19 دی 1391, 00:07 صبح
باسلام
اگه دقت کرده باشین وقتی متدی رو میخواین استفاده کنید یه توضیح کوچولو کنارش میاد که میگه کارش چیه چیزی برمیگردونه یا و.....
من تو dll که نوشتم یه چند تا متد دارم میخوام براشون تویحی بنویسم کهوقتی کسی ازش استفاده کرد نشون بده کتارش
یه شوال دیگه چطور میتونمبه نوار peropertise یه خاصیت برای usercontorlibrary که ساختم اظافه کنم

the king
سه شنبه 19 دی 1391, 01:37 صبح
باسلام
اگه دقت کرده باشین وقتی متدی رو میخواین استفاده کنید یه توضیح کوچولو کنارش میاد که میگه کارش چیه چیزی برمیگردونه یا و.....
من تو dll که نوشتم یه چند تا متد دارم میخوام براشون تویحی بنویسم کهوقتی کسی ازش استفاده کرد نشون بده کتارش
یه شوال دیگه چطور میتونمبه نوار peropertise یه خاصیت برای usercontorlibrary که ساختم اظافه کنم

ابتدا منوی Project ویژوال استدیو گزینه ...project name} Properties} رو انتخاب کنید. زبانه Build رو انتخاب نمایید. اونجا یک گزینه ای
به عنوان XML documentation file هست. تیک اش بزنید. اون فایل XML ای که مسیرش رو مشخص می کنه باید همیشه همراه
فایل DLL تون و کنارش باشه، توضیحاتی که می نویسید بعد از کامپایل شدن پروژه تون داخل اون ذخیره میشه.

دو جور توضیحات داریم، یکی اون توضیحاتی که Editor و Object Browser نشون میده و یکی اون توضیحاتی که در پنجره Properties برای مشخصات
نشون داده میشه، اینها با هم فرق دارند. برای نوشتن توضیحاتی که Editor و Object Browser نشون میده، یک سطر بالاتر از اون موردی که قراره برایش
توضیحات بنویسید سه کاراکتر /// رو تایپ کنید، خود ویرایشگر تگ های مناسب اون موضوع رو در سطر های بعدی و بعد از همون /// می نویسه :


/// <summary>
/// This is a sample.
/// </summary>
public enum MyEnum
{
/// <summary>
/// Single Mode
/// </summary>
SingleMode,
/// <summary>
/// Double Mode
/// </summary>
DoubleMode
}

/// <summary>
/// Gets the telephone value.
/// </summary>
/// <param name="mobile">
/// Indicates whether the device is mobile.
/// </param>
/// <returns>
/// The telephone value.
/// </returns>
public string Telephone(bool mobile)
{
if (mobile)
return _mobile;
else
return _home;
}


اما توضیحاتی که در پنجره Properties و برای مشخصه ها نشون داده می شوند با صفت Description تعیین می شوند :


[System.ComponentModel.Category("Appearance")]
[System.ComponentModel.Description("The face color of the control.")]
public Color FaceColor
{
get
{
return _FaceColor;
}
set
{
_FaceColor = value;
}
}

ordebehesht
سه شنبه 19 دی 1391, 13:44 عصر
[System.ComponentModel.Category("Appearance")]
[System.ComponentModel.Description("The face color of the control.")]
public Color FaceColor
{
get
{
return _FaceColor;
}
set
{
_FaceColor = value;
}
}




میشه بیشتر توضیح بدین

ordebehesht
سه شنبه 19 دی 1391, 13:49 عصر
البته بگم منظورم از توضیحات این بود که همونطور برای textbox خاصیتی بنام text هست و متن داخل رو نشون میده برای کنترل ساخته شده هم این شکلی یه چیز بزار

the king
چهارشنبه 20 دی 1391, 06:03 صبح
[System.ComponentModel.Category("Appearance")]
[System.ComponentModel.Description("The face color of the control.")]
public Color FaceColor
{
get
{
return _FaceColor;
}
set
{
_FaceColor = value;
}
}




میشه بیشتر توضیح بدین

مشخصه هایی که هم قابل خواندن هستند و هم نوشتن، هم بخش get دارند و هم set
فرق شان با متغیر Public معمولی در این است که اولا روی خواندن و نوشتن کنترل دقیقی دارید و ثانیا می توانید متوجه بشوید که
کی مقدارشان تغییر می کند و در ضمن در پنجره Properties هم قابل نمایش اند و مقدار داده ای شان می تواند همراه فرم ذخیره شود
تا دفعه بعدی که فرم را باز کردید مقدار قبلی از دست نرود.

این یک مثال از یک مشخصه جدید به اسم FaceColor است که برای یک کلاس نوشته میشه و در پنجره Properties قابل تعیین کردنه،
اما یک متغیر به اسم FaceColor_ و با نوع داده Color بسازید که private خواهد بود و مقدار این مشخصه را نگهداری خواهد کرد.
این مشخصه جزء گروه مشخصه های Appearance است و توضیحات اش هم نشان داده خواهد شد.