Ответы с форумов MSDN

XML-документация для библиотеки .NET

Date: 03.03.2017 17:56:45

Создать XML-документацию для чужой библиотеки, конечно, можно. Для этого нужно создать в папке со сборкой, на которую вы ссылаетесь, XML-файл, совпадающий с именем сборки, такого содержания:

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>MyCoolAssembly</name>
    </assembly>
    <members>
		<!--- Документация класса --->
		<member name="T:MyNamespace.MyClass">
            <summary>
            Описание класса
            </summary>
        </member>
	
		<!--- Документация метода --->
		<member name="M:MyNamespace.MyClass.DoSomething(Int32)">
            <summary>
            Описание метода
            </summary>
            <param name="x">Описание аргумента метода</param>
        </member>
		
		<!--- Документация поля --->
		<member name="F:MyNamespace.MyClass.FieldType.FieldName">
            <summary>
            Описание поля
            </summary>
        </member>
	
	</members>
</doc>

Такой файл обычно генерируется автоматически компилятором при установки галки "Генерировать XML-документацию" в свойствах проекта.

Подробное описание тегов для разных элементов языка можно найти здесь: Processing the XML File



Автор: VadimTagil

Главная страница - Список тем - Репозиторий на GitHub