مستند سازی برنامه های نوشته شده در VB.NET

[jseyyedzadeh]

همانطوری که اکثر ما می دانیم، مستندسازی نرم افزارهای نوشته شده و از جمله کدهای نوشته شده یکی از فازهای مهم توسعه نرم افزاراست. این بخش مهم معمولاٌ مورد بی توجهی قرار می گیرد. بخش مستند سازی یک بخش کینه توز است که اگر مورد بی مهری قرارگیرد، انتقام سختی پیش روی توسعه گران نرم افزار خواهد بود. این انتقام بدین صورت است که بعد ازمدتی دچار سردرگمی عجیبی خواهیم شد که تا مرز توسعه دوباره بخش هایی از نرم افزار پیش خواهیم رفت. با این مقدمه کوچک به تشریح یک روش ساده مستندسازی کدهای نوشته پرداخته می شود. هرچند این نوشته برای محیط VB.NET نوشته می شود ولی با اندک تغییراتی در مورد C#.Net نیز کارا است.
کار کردن با ادیتور سایت برایم راحت نیست. من فایل ZIP شده‌ای را که حاوی یک فایل DOC است برایتان ارسال می‌کنم. این فایل در Ms Word 2003 و با فونت B yagut و سایز 14 تهیه شده است.

[Sub Zero]

ضمن تشکر و خوش امد گویی به شما کاربر محترم . خواهشمندم پست ایجاد شده رو در تاپیک Code Sample (http://barnamenevis.org/forum/showthread.php?t=58718&page=7) (جهت دسترسی سریع کاربران) نیز قرار بدید

[مهدی ویژوال]

آقا چرا من اجازه دانلود این مطلب را ندارم

[jseyyedzadeh]

بنده همین الان این برنامه را دانلود کرده و باز کردم. سایت مشکلی ندارد.در صورت نیاز آدرس ایمیل بفرستید تا من برایتان ارسال کنم.
سیدزاده ساران

[alinaghiha]

منم دانلود کردم مشکلی نداشت

آقا ممنون کار قشنگی بود
موفق باشید

[visual_sadegh]

سلام
میدونم که این تاپیک مال خیلی وقت پیشه
ولی کسی تجربه ای درخصوص مستند سازی نرم افزار برای یک شرکت نرم افزاری داره؟
به این شکل که ما یک شناسنامه در خصوص نرم افزار داشته باشیم که شامل مشخصات پروژه مثل
نام نرم افزار
صاحب کار
قیمت
تاریخ شروع
تاریخ پایان و...
باشه
و همچنین مشخصات فنی مثل فرم ها و روال ها و توابع و همچنین مشخصات دیتابیس شامل جداول و ارتباط بین جداول و ...
اگه کسی تا بحال چنین کاری انجام داده ممنون می شم تجربیاتش رو در اختیار ما قرار بده

[visual_sadegh]

سلام
کسی خونه نیست؟

[visual_sadegh]

من باید تا کی این تاپیکو سرپانگه دارم
کسی تو سایت نیست که توی یک شرکت نرم افزاری کار کنه؟

[__H2__]

سلام

به این شکل که ما یک شناسنامه در خصوص نرم افزار داشته باشیم که شامل مشخصات پروژه مثل
نام نرم افزار
صاحب کار
قیمت
تاریخ شروع
تاریخ پایان و...
باشه
و همچنین مشخصات فنی مثل فرم ها و روال ها و توابع و همچنین مشخصات دیتابیس شامل جداول و ارتباط بین جداول و ...
اگه کسی تا بحال چنین کاری انجام داده ممنون می شم تجربیاتش رو در اختیار ما قرار بده


چیزی که شما میخواهید بیشتر یک نوع کار مدیریتی است و چیزی نیست که در یک خط جواب داده شود و یا با سمپل ساده کل مشکلات شما حل شود.

میتوانید از اجتماع روش ها استفاده کنید.
- صفر امین لایه (!) مستند سازی انتخاب نام های بامعنی برای متغییر ها و روال ها است.
- لایه بعدی استفاده از درج توجیحات xml ای خصوص کدها است (که در VB با سه تک کتیشن آغاز میشود و میتواند تا حدودی از فایل xml خارجی هم انجام شود.)
- لایه بعدی استفاده از فایل های cd در داخل پروژه است که میتوانید ضمن مشخص کردن روابط کلاسس ها و ساختارها، توضیحات را هم راحت تر وارد نمایید.
- لایه بعدی استفاده از uml و visio جهت مشخص کردن ساختار کلی با شکل است.
- در نهایت میتوانید یک برنامه مدیریتی و بانک اطلاعاتی هم برای خودتان بسازید که اطلاعاتی مثل کد برنامه و سفارش دهنده و تاریخ شروع و پایان و مبلغ قرار داد و دوره های پرداخت و اهداف برنامه و... را در بانک اطلاعاتی (مثلاً sqlserver) نگه داری و مدیریت (ویرایش و جستجو و گزارش و...) کند.