توثيق برنامجك الياً اثناء كتابته

اذا اردت طريقه سهله لتوثيق برنامجك اثناء كتابته دون عناء او بذل جهد اضافى فأستخد XML والتعليق بإستخدام /// فى #C أو ''' فى VB.NET

بفرض لديك مشروع جديد بأسم ConsoleHelp ويحتوى على كلاس بأسم ConsoleHelp كالتالى:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace ConsoleHelp
{
	/// <summary>
	/// ClassTest Class
	/// for test purpose only
	/// </summary>
	class ClassTest
	{
		private int ID;
		private string Username;

		/// <summary>
		/// ClassTest Constractor
		/// </summary>
		public ClassTest()
		{

		}

		/// <summary>
		/// Function SetID
		/// </summary>
		/// <param name="i"></param>
		public void SetID(int i)
		{
			ID = i;
		}
	}
}

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace ConsoleHelp
{
	class Program
	{
		/// <summary>
		/// Main (entry point)
		/// </summary>
		/// <param name="args"></param>
		static void Main(string[] args)
		{
		}
	}
}

لاحظ انى استخدمت التعليقات باستخدام /// بصيغ XML ومعانيها كما فى الجدول التالى:

<c>Indicates that the following text should be displayed in a specific “code font”

<code>Indicates multiple lines should be marked as code

<example>Mocks up a code example for the item you are describing

<exception>Documents which exceptions a given class may throw

<list>Inserts a list or table into the documentation file

<param>Describes a given parameter

<paramref>Associates a given XML tag with a specific parameter

<permission>Documents the security constraints for a given member

<remarks>Builds a description for a given member

<returns>Documents the return value of the member

<see>Cross-references related items in the document

<seealso>Builds an “also see” section within a description

<summary>Documents the “executive summary” for a given member

<value>Documents a given property

بعد ذلك أختر Project Properties - ثـم -> Build - ثـم -> ضع علامة صح على XML Documentation file

أضغط F6 لترجمة البرنامج

ادخل فى المجلد bin\Debug\. ستجد تم انشاء الملف ConsoleHelp.XML وهو يحتوى على المساعدة بصيغة XML

حمل وثبت البرنامج NDoc من الموقع: http://sourceforge.net/projects/ndoc

شغل الملف NDocGui.exe من المسار: C:\Program Files\NDoc\bin\net\1.1

أضغط زرار Add وأختر برنامجك ثم OK

أختر فى Documeny Type التالى: MSDN

أختر فى OutputTarget التالى: Help

أختر فى DocumentInternals التالى: True

من قائمة Document أختر Build أو أضغط CTRL + Shift + B

ستجد الملف Documentation.chm يحتوى على توثيق البرنامج الخاص بك

كذلك يمكنك استخدام البرنامج Sandcastledocs من الموقع http://www.sandcastledocs.com بدلاً من NDoc

اذا كنت تستخدم سطر الاوامر للترجمه يمكنك استخدام الصيغة: csc /doc:ConsoleHelp.XML *.cs