مستند کردن برنامه [بایگانی]

karimi84

شنبه 10 اردیبهشت 1384, 19:03 عصر

برای اینکه بتوانم برنامه ای را که نوشتم مستند کردم چه کار باید کنم

یاشار

شنبه 10 اردیبهشت 1384, 21:04 عصر

منظورتون مستند کردن کد برنامه است یا نوشتن راهنما برای کاربر (Help ) ؟

نوشتن Help (http://www.barnamenevis.org/forum/viewtopic.php?t=24537)

کد برنامه ...

karimi84

شنبه 10 اردیبهشت 1384, 21:27 عصر

منظورم کد برنامه است

یاشار

شنبه 10 اردیبهشت 1384, 21:36 عصر

برای کد در #C امکاناتی به صورت آماده وجود داره که البته در VB.NET هم بوسیله چند تا شرکت متفرقه شبیه سازی شده. مثلا میتونید با نوشتن سه تا ' قبل از هر متد یا فیلد یه سری کامنت به صورت اتوماتیک ایجاد کنید که به صورت XML ذخیره میشن و کسانی که از کد شما استفاده میکنند میتونن توضیحات شما رو توی Intellisense و Object Viewer بخونن. مثل vbdocman (http://www.vbdocman.com)

علیرضا مداح

شنبه 10 اردیبهشت 1384, 22:28 عصر

سلام .
البته ویژگی XML Documentation به VB 2005 اضافه گردیده است :
http://msdn.microsoft.com/library/en-us/dnvs05/html/vbnet2005_preview-fig17.gif

اما چون در نگارش فعلی VB.Net این ویژگی به صورت Built-In وجود ندارد ، شما میبایست از ابزاری به نام XML Documentation Tool استفاده نمایید :
http://www.gotdotnet.com/team/vb/XMLDoc.JPG

Download XML Documentation Tool (http://www.microsoft.com/downloads/details.aspx?FamilyID=f8400fa9-a3af-4c8b-9e84-fec88f198b4b&displaylang=en)

titbasoft

یک شنبه 11 اردیبهشت 1384, 00:07 صبح

آقای مداح از لینکتون ممنونم اصلا فکر نمی کردم توی VB هم بشه این کار رو انجام داد :تشویق:
یاشار جان vbdocman خیلی عالیه ولی یه کم گرونه . شما توی بازار تهران دیدینش ؟ اگه سراغ دارید میشه آدرس بدین! :wink:

یاشار

یک شنبه 11 اردیبهشت 1384, 15:09 عصر

-خوب، خیلی هم عالی که توی 2005 اضافه شده.

-نه متاسفانه تا حال جایی ندیدمش. اگر شما دیدید ما رو هم بی نصیب نگذارین ... :موفق: