Шаг 42 -XML документация кода

В С# можно создавать документацию прямо в коде приложения на основе XML стандарта. Для этого в коде пишутся комментарии оформленные в виде XML тегов которые впоследствии могут быть выбраны компилятором и переведены в HTML файл. В компиляторе есть ключ /doc:файл. Вот пример:

csc /doc:doc.xml MainForm.cs

А вот код, который используется для генерации документации вместе с комментариями.

using System;
using System.Windows.Forms;
using System.Drawing;
using System.IO;
/// <summary>
	///	Class Application.
/// </summary>
class MyForm : AppForm 
{
	public static void Main()
	{
		Application.Run(new MyForm());
	}
}

/// <summary>
	///	Class Form.
/// </summary>
class AppForm : Form
{
	public AppForm()
	{
		MainMenu mnuFileMenu = new MainMenu();
		this.Menu = mnuFileMenu;
		MenuItem MenuItemFile = new MenuItem("&File");
		mnuFileMenu.MenuItems.Add(MenuItemFile);
		ToolBar toolBar1 = new ToolBar();
		ToolBarButton toolBarButton1 = new ToolBarButton();
		toolBarButton1.Text = "Open";
		toolBar1.Buttons.Add(toolBarButton1);
		Controls.Add(toolBar1);
	}
}

Gосле компиляции будет сформирован помимо прочего XML файл.

gif/42_1.gif (2328 b)

Посмотреть его можно в любом тестовом редакторе ну и в Exploler естественно.

gif/42_2.gif (9071 b)


Загрузить проект | Предыдущий Шаг | Следующий Шаг | Оглавление
Автор Каев Артем.