این وبلاگ به منظور آشنایی شما با کامپیوتر و زیر نظر شرکت آرت کام می باشد. امیدوارم شما عزیزان با نظرات خود بنده را در کارآمد بودن مطالب این وبلاگ همراهی نماییید.
همانطوری که اکثر ما می دانیم، مستندسازی نرم افزارهای نوشته شده و از جمله کدهای نوشته شده یکی از فازهای مهم توسعه نرم افزاراست. این بخش مهم معمولاٌ مورد بی توجهی قرار می گیرد. بخش مستند سازی یک بخش کینه توز است که اگر مورد بی مهری قرارگیرد، انتقام سختی پیش روی توسعه گران نرم افزار خواهد بود. این انتقام بدین صورت است که بعد ازمدتی دچار سردرگمی عجیبی خواهیم شد که تا مرز توسعه دوباره بخش هایی از نرم افزار پیش خواهیم رفت. با این مقدمه کوچک به تشریح یک روش ساده کدهای نوشته پرداخته می شود. هرچند این نوشته برای محیط VB.NET نوشته می شود ولی با اندک تغییراتی در مورد C#.Net نیز کارا است.
توضیحات XML با استفاده از نوشتن ''' (سه تک کوتیشن پشت سرهم) در محیط Vb.Net امکان پذیر است. ویژوال استودیو به صورت خودکار برخی مداخل XML را به متن برنامه اضافه می کند.
یکی از کمکهای اولیه این مستند سازی به هنگام نوشتن برنامه ارائه توضیحات به خود برنامه نویس است. به شکلهای زیر توجه کنید.
همچنین این توضیحات را می توانید برای مستند سازی برنامه خود استفاده کنید. برای ایجاد فایل XML باید تنظیمات لازم را انجام داده باشید.(به صورت پیش فرض این تنظیمات آماده استفاده هستند.)شما می توانید این تنظیمات را از مسیر زیر انجام دهید.
منوی : (Project -( Properties
با انجام این تنظیمات به هنگام کامپایل کردن برنامه خود، یک فایل XML که همنام با نام پروژه تان است، در کنار فایل اجرایی ایجاد می شود.
این فایل تمامی توضیحات بخش های مختلف کد را در خود جای داده است.
برخی از این اطلاعات در Object Browser محیط Visual Studio نیز مورد استفاده قرار می گیرد.
برای مطالعه برچسب های XML که در مستند سازی بکار برده میشود, به آدرس زیر مراجعه فرمائید.
http://www.winnershtriangle.com/w/Articles.XMLCommentsInVBNet.asp
شما می توانید این فایل را بعنوان ورودی به نرم افزارهای مستند سازی وارد نموده و مستندسازی خود را با قالب های مختلف دریافت کنید.
همچنین می توانید یک فایل XSL. بنویسید تا فایل XML. را به قالب مورد نظر شما تبدیل کند. به عنوان یک نمونه ساده و زیبا می توانید به آدرس زیر مراجعه نموده و فایل XSL. را دریافت نمائید. با افزودن یک خط به ابتدای فایل XML. خود می توانید بر روی آن Double Click نموده و آن را در قالب HTML مشاهده کنید.
http://www.codeproject.com/soap/XMLDocStylesheet.asp
امیدوارم این نوشته مورد توجه و استفاده دوستان و همراهان عزیز قرار گیرد.
منبع:http://www.persiadevelopers.com
نوشته شده توسط مجید دامن افشان در یکشنبه بیست و هفتم آبان 1386
>
نوشته شده توسط مجید دامن افشان در یکشنبه بیست و هفتم آبان 1386 
لينك مطلب
مطالب پیشین