Obsolete 11 страница
Каждый элемент списка задается блоком <item>. При создании списка определений необходимо задать и термин, и описание. Но для таблицы, маркированного списка или нумерованного списка необходимо задать только описание. Синтаксис: <list type="bullet" | "number" | "table"> где term определяемый термин, определенный в описание;. description либо элемент маркированного или нумерованного списка, либо определение термина;. Пример: public class MyClass A.2.7 <para> Этот тег используется внутри других тегов, таких как <summary> (§A.2.11) или <returns> (§A.2.12), и позволяет добавить структуру к тексту. Синтаксис: <para> content </para> где content текст абзаца. Пример: /// <summary>This is the entry point of the Point class testing program. A.2.8 <param> Этот тег используется для описания параметра метода, конструктора или индексатора. Синтаксис: <param name=" name "> description </param> где name имя параметра. description описание параметра. Пример: /// <summary>This method changes the point's location to A.2.9 <paramref> Этот тег используется для указания, что слово является параметром. Файл документации может быть обработан так, чтобы этот параметр был представлен выделяющимся образом. Синтаксис: <paramref name=" name "/> где name имя параметра. Пример: /// <summary>This constructor initializes the new Point to public Point(int xor, int yor) { A.2.10 <permission> Этот тег дает возможность документировать специальные возможности безопасности члена. Синтаксис: <permission cref=" member "> description </permission> где cref=" member " имя члена. Генератор документации проверяет, что данный элемент кода существует, и преобразует член в каноническое имя элемента в файле документации. description описание доступа к члену. Пример: /// <permission cref="System.Security.PermissionSet">Everyone can public static void Test() { A.2.11 <remark> Этот тег используется для указания дополнительных сведений о типе (используйте <summary> (§A.2.15) для описания самого типа и членов типа.) Синтаксис: <remark> description </remark> где description Текст примечания. Пример: /// <summary>Class <c>Point</c> models a point in a A.2.12 <returns> Этот тег используется для описания возвращаемого методом значения. Синтаксис: <returns> description </returns> где description описание возвращаемого значения. Пример: /// <summary>Report a point's location as a string.</summary> A.2.13 <see> Этот тег дает возможность указать ссылку внутри текста. Используйте <seealso> (§A.2.14) для указания текста, который должен быть представлен в разделе См. также;. Синтаксис: <see cref=" member "/> где cref=" member " имя члена. Генератор документации проверяет, что данный элемент кода существует, и заменяет член; на имя элемента в сгенерированном файле документации. Пример: /// <summary>This method changes the point's location to /// <summary>This method changes the point's location by A.2.14 <seealso> Этот тег дает возможность создания записи для раздела См. также;. Используйте <see> (§A.2.13) для указания ссылки изнутри текста. Синтаксис: <seealso cref=" member "/> где cref=" member " имя члена. Генератор документации проверяет, что данный элемент кода существует, и заменяет член; на имя элемента в сгенерированном файле документации. Пример: /// <summary>This method determines whether two Points have the same A.2.15 <summary> Этот тег используется для описания типа или члена типа. Используйте <remark> (§A.2.11) для описания самого типа. Синтаксис: <summary> description </summary> где description Сводные сведения о типе или члене. Пример: /// <summary>This constructor initializes the new Point to (0,0).</summary> A.2.16 <value> Этот тег дает возможность описать свойство. Синтаксис: <value> property description </value> где property description описание свойства. Пример: /// <value>Property <c>X</c> represents the point's x-coordinate.</value> A.2.17 <typeparam> Этот тег используется для описания параметра универсального типа для класса, структуры, интерфейса, делегата и метода. Синтаксис: <typeparam name=" name "> description </typeparam> где name имя параметра типа. description описание параметра типа. Пример: /// <summary>A generic list class.</summary> A.2.18 <typeparamref> Этот тег используется для указания, что слово является параметром типа. Файл документации может быть обработан так, чтобы этот параметр типа был представлен выделяющимся образом. Синтаксис: <typeparamref name=" name "/> где name имя параметра типа. Пример: /// <summary>This method fetches data and returns a list of <typeparamref name=”T”> ”/>”>.</summary> public List<T> FetchData<T>(string query) { A.3 Обработка файла документации Генератор документации создает строку идентификатора для каждого элемента исходного кода, помеченного комментарием к документации. Эта строка идентификатора однозначно идентифицирует элемент источника. Средство просмотра документации может использовать строку идентификатора для идентификации соответствующего элемента метаданных или отражения, к которому применяется документация. Файл документации не является иерархическим представлением исходного кода, это, скорее, единообразный список с созданной для каждого элемента строкой идентификатора. A.3.1 Формат строки идентификатора При создании строк идентификаторов генератор документации соблюдает следующие правила: · в строку не заносятся пробелы; · первая часть строки идентифицирует вид документируемого члена с помощью одного символа, за которым следует двоеточие. Определены следующие виды членов:
|