ما هي طريقة عمل comments في مكتبات ال DLL المبرمجة

السلام عليكم

من قائمة Tools أختار Procedure Attributes ثم اختار ال Procedure الذي تريد وفي خانة Descriptions ضع وصفه

أّمل ان هذا الذي تريد

والله أعلم

ويا ريت أخي الكريم لو سمحت ان تضع عنوان مناسب للموضوع

*** هام جدا *** قواعد طرح الأسئله والمشاركات

اذهب الى بداية الدالة بعد كلمة Function أو sub واضغط باليمين ثم اختار Insert Comment واكتيب ماتريده

انظر الصورة

السلام عليكم

أسف جدا لم انتبه انه منتدى ال VB.NET فلم انتبه الى .NET

على اية حال في ال 2005 فتصتطيع اضافة التوثيق فوق الميثود كما وضح لأخ Scoool مشكور في الصورة

اما في ال2003 فيجب ان توضع في ملف xml خارخي يحمل اسم المشروع ويكون كالتالي

class or structure or module start with T
<member name="T:NameSpacce.ClassName">
	<summary>the Description hear</summary>
	<remarks>the Remarks hear</remarks>
</member>


Method(function or sub) start with M
<member name="M:NameSpacce.ClassName.MethodName(function or sub)">
	<summary>the Description hear</summary>
	<remarks>the Remarks hear</remarks>
</member>


Property start with P
<member name="P:NameSpacce.ClassName.PropertyName">
	<summary>the Description hear</summary>
	<remarks>the Remarks hear</remarks>
</member>



variable start with F
<member name="F:NameSpacce.ClassName.VarName">
	<summary>the Description hear</summary>
	<remarks>the Remarks hear</remarks>
</member>

الأسماء في ملف ال xml حسلسة لحالة الحرف ويجب ان تطابق الأسماء في مشروعك

والله أعلم

أرجوا ان يفيدك

---------------------------------

---------------------------------

السلام عليكم

تم أضافة هذه الجزئية الى الموضوع

XML Documentation Tool

101 Visual Basic and C# Code Samples

عفوا الاخوين سوييت اللي قلتوه بس ما استفدت شي (ما لقيت نتيجة) لم اسوي كائن من الصنف اللي انا مبرمجو في داخل ال DLL

ابي اقربلكم الفكرة اكثر بصورة و اللي اطلب اضيفه هو الجزء اللي مأشر عليه بمستطيل احمر في الصورة

السلام عليكم

لنفرض ان لديك الميثود لتالية

function ReferenceEquals(objA as object,objB as object)as boolean

فالدوكيمنتيشن لهذه المثود ستكون كالتالي

<member name="M:NameSpace.ClassName.ReferenceEquals(System.Object,System.Object)">
  <summary>the summery here</summary>
  <param name="objA">first object description</param>
  <param name="objB">secound object description</param>
  <returns>the return value here</returns>
</member>

على فكرة .. خارج الموضوع ..

أعتقد انه المنتدى لازم يشوف لنا حل يفرق فيه عن 2003 و 2005

الاخوة المشاركين

احب الفت انتباهكم انا استخدم visual studio 2005

السلام عليكم

الأخ Scoool جاوبك عن ال 2005 كما جاء في رده التالي

Scoool كتب:

اذهب الى بداية الدالة بعد كلمة Function أو sub واضغط باليمين ثم اختار Insert Comment واكتيب ماتريده

انظر الصورة

علي أية حال ان ال documentation لها ستكون كالتالي

''' <summary>
''' the summery here
''' </summary>
''' <param name="objA">first object description</param>
''' <param name="objB">secound object description</param>
''' <returns>the return value here</returns>
function ReferenceEquals(objA as object,objB as object)as boolean

اقتباس

على فكرة .. خارج الموضوع ..

أعتقد انه المنتدى لازم يشوف لنا حل يفرق فيه عن 2003 و 2005

هى بس ثلاث ضغطات من ''' هتلاقية فتحلك الكومنت تدخل فية الى انت عايزة

شكرا لجميع المشاركين

معلومات حلوة زودتمونا بها و لكن للأسف لا تظهر اي نتيجة عند تطبيق هذا الشيء

على ملف ال DLL فعندما استدعي هذه الدوال الموجودة بداخل الأصناف لا تظهر اي تعليقات فقط اسم المتغير الذي يجب تمريره للدالة

و اعود و اكرر شكري للجميع

اين يجب وضع ملف ال XML الذي يحتوي على ال Documentation ؟؟؟