PDA

View Full Version : سوال: داکیومنت های پروژه چه چیزایی هستند؟


Mosafers
جمعه 15 دی 1391, 12:46 عصر
سلام دوستان یه پروژه کوچیک دارم مینویسم دانشجویی استاد بهم گفته داکیومنت ها باید کامل باشه ...

اما نمیدونم داکیومنت ها چه چیزایی رو در بر میگیره.

اگه یه نمونه از یک پروژه هم داشته باشید عالی میشه...
user6627
جمعه 15 دی 1391, 13:05 عصر
سلام
داکیومنت به مجموعه توضیحاتی گفته میشه که بخش های مختلف یک نرم افزار را برای خود شخص در استفاده های بعدی و همچنین برای دیگران قابل فهم میکنه که دیگه نیازی نباشه طرف از طریق پیگیری خود الگوریتم متوجه عملکردش باشه
حالا داکیومنت میتونه به شکل های مختلف باشه :
برای برنامه نویس ها میتونه شامل توضیحات درون خود کد برنامه (که میتونه از یک خط کد را توضیح بده تا یک تابع یا کلاس یا ...) که در مورد کد میتونه بصورت // یا /**/ یا /// مشخص بشه که با استفاده از /// میتونین از خارج از اون کد توضیحاتش را ببینید ولی برای دیدن توضیحات در دو حالت دیگه باید کد را ببینید،
و همچنین توضیحات مربوط به ساختار برنامه مثلا نحوه ارتباط اجزای برنامه به هم و اینکه عملکرد هرکدام چی باشه!
همچنین در مورد پایگاه داده هم میتوان با استفاده از نرم افزار هایی داکیومنت ساخت که مثلا فلان جدول یا فلان ستون کارش چیه

و اما داکیومنت برای غیر برنامه نویس ها شامل همان فایل های Help هست که نمونش در اکثر برنامه هاست و توسط نرم افزار هایی میتوان آنها را ساخت

خلاصه که هدف از ایجاد کردن داکیومنت ، مستند سازی و توضیح قسمت های مختلف نرم افزارتون برای فهم سریع بخش های مختلف نرم افزار بصورت جزئی و کلی میباشد!!!
Mosafers
جمعه 15 دی 1391, 13:46 عصر
واقعا واضع و عالی بود...

اول فرق /// با // چیه؟ // که برای کتمنت گذاری هستش اما این /// ؟

پس مستندات پروژه چه چیزهایی رو در بر میگیره؟
user6627
جمعه 15 دی 1391, 15:15 عصر
اول فرق /// با // چیه؟ // که برای کتمنت گذاری هستش اما این /// ؟




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