اضافه کردن توضیحات

[حامد فراست]

با سلام
می خواستم بدونم چطوری میشه برای اجزای یک شی مثل property هاو method ها و ...توضیحاتشو ن رو اضافه کرد تا برنامه نویس در حین استفاده بدونه مثلا تابع ( )A چه کار مینکه مثل کامپوننتهای خودVS
:متفکر:

[NewFoxStudent]

/// <


از این استفاده کن
یه لیست باز میشه که میتونی از گزینه هاش استفاده کنی

[esmaeily-hosein]

یا Att Description برای پروپرتی ها در زمان Design mode

[Description("The Size of the control"]
public Size Size
{
get;
set;
}

[احمد سامعی]

/// <


از این استفاده کن
یه لیست باز میشه که میتونی از گزینه هاش استفاده کنی

من از روش استفاده مي كنم اما توضيحات وارد شده فقط تو همون پروژه قابل ديدن و اگر يك DLL باشه تو برنامه بعدي كه از اين DLL استفاده كردم ديگه اون توضيحات ديده نمي شه ؟؟

[esmaeily-hosein]

نمیدونم منکه توش مشکلی تا حالا ندیم . میتونی اینجوری هم بنویسی

// Summary:
// HelloWorld
//

[حامد فراست]

من از

///<
استفاده کردم اما جواب نداد
کسی راه دیگه سراغ داره؟
:متفکر:

[salehbagheri]

///<
اين ديگه چيه؟

شما بايد اينطوري استفاده كنيد!



/// <summary>
/// Code Descriptions
/// </summary>


حتما جواب ميده، يعني بايد جواب بده!

[adibadm]

منم استفاده کردم برای توضیح توابع داخل یک کلاس
اگر در خود کلاس از توابع استفاده کنم توضیحات رو نشون می ده اما اگه در فرم ها از کلاس (همون توابع )استفاده کنم توضیحات نمایش داده نمی شه

[NewFoxStudent]

///<
اين ديگه چيه؟

شما بايد اينطوري استفاده كنيد!



///<summary>
/// Code Descriptions
///</summary>


حتما جواب ميده، يعني بايد جواب بده!

وقتی این رو توی vs تایپ کنی یه لیست باز میشه که میتونی ازش انتخاب کنی
بخاطر همین اینطوری نوشتم

[حامد فراست]

تموم این روش های که گفتین توی همون پروژه جواب میده اما بیرون از اون اثری نداره . من یک کامپوننت دارم که برایproperty هاش وMethod هاش احتیاج به توضیح دادن دارم. یعنی تو هر پروژ وبرنامه ای قرار گرفت توضیحاتش برای برنامه نویس قابل دیدن باشه:عصبانی++:

[حامد فراست]

یا Att Description برای پروپرتی ها در زمان Design mode

[Description("The Size of the control"]
public Size Size
{
get;
set;
}

میشه در مورد این روش بیشتر توضیح بدین:متفکر:
من این قطعه کد رو نوشتم ولی جواب نداد

[esmaeily-hosein]

همونطور که گفتم برای design mode به کار میره
http://www.freeimagehosting.net/uploads/f2b9f9d5b6.png
به خط قرمز توجه کن .

[حامد فراست]

پس تو محیط کد نویسی چطور میشه توضیحات اضافه کردبرای کاربری که بعدا از این کامپوننت یا DLLاستفاده میکنه:گریه:

[rnm123]

دوست عزیز برای حل این مشکل کارهای زیر را انجام بده :
در پروژه کلاس خود بر روی نام پروژه در پنجره sulotion Explorer راست کلیک کرده و properties را انتخاب کنید . در پنجره باز شده از سربرگ build از قسمت output گزینه XML Documentation File را تیک بزنید و یک نام برای انتخاب کنید که بهتر همنام کلاس شما باشد
تغغیرات را ذخیره نمائید .
همانطوری که دوستان در بالا توضیح دادند قبل از تابع در کلاس خود با زدن 3 بار پیاپی کاراکتر / خود vs یک ساختاری توضیحاتی باز میکند که این ساختار بر اساس نوع خروجی و پارامترهای تابع شما دارای چند گزینه میباشد لازم است توضیحات مربوط به نوع خروجی تابع و نیز توضیحات مربوط به پارامترهای های ورودی را با رعایت تعداد آنها در این قسمت وارد نمائید . حالا اگر کلاس خود را build نمائید در کنار فایل dll شما یک فایل xml هم ایجاد میشود . برای نمایش داده شدن توضیحات شما لازم است هر کجا که فایلdll خود را استفاده مینمائید ( add میکنید ) حتما ان فایل xml را هم در کنار آن کپی نمائید . در اینصورت در محیط vs هنگام استفاده از کلاس و توابع آن توضیحات داده شده توسط شده ( توضیحات مربوط به پارامترها و نوع خروجی تابع ) ( دقیقا مثل خود vs ) نمایش داده میشود حتی اگر برای تابع خود بر اساس نوع پارامترهای ورودی حالت های مختلفی داشته باشید ( تابع انواع مختلفی از پارامترها را قبول کند ) باز هم اینگونه توابع بخوبی توضیحاتشان نمایش داده میشود