Документация XML для пространства имен
Вы пытались использовать метод .get? Если нет , то здесь является ссылкой на документы Python, которая возвращает None, если ключ не найден, это предотвратит ошибку ключа.
4 ответа
NDoc поддерживает это, распознавая специальный класс NamespaceDoc , расположенный в каждом пространстве имен, и используя соответствующую документацию. Я не пробовал, но Sandcastle, кажется, поддерживает тот же трюк.
Редактировать: Например:
namespace Some.Namespace
{
/// <summary>
/// This namespace contains stuff
/// </summary>
public static class NamespaceDoc
{
}
}
Sandcastle напрямую не поддерживает NamespaceDoc, но если вы используете Построитель файлов справки Sandcastle , вы можете использовать класс NamespaceDoc, упомянутый Тимом.
namespace Example
{
/// <summary>
/// <para>
/// Summary
/// </para>
/// </summary>
/// <include file='_Namespace.xml' path='Documentation/*' />
internal class NamespaceDoc
{
}
}
SCHB также расширяет синтаксис немного и позволяет встраивать примеры кода прямо из файлов кода. Пример _Namespace.xml:
<?xml version="1.0" encoding="utf-8" ?>
<Documentation>
<summary>
<h1 class="heading">Example Namespace</h1>
<para>
This namespace is used in the following way:
</para>
<code source="Examples\Class.cs" lang="cs"></code>
<code source="Examples\Class.vb" lang="vbnet"></code>
<para>
Hopefully this helps!
</para>
</summary>
</Documentation>
Включение документации в файл XML позволяет записать краткое резюме в коде и подробное описание в отдельный файл XML для файла справки. Таким образом, код не загроможден всеми деталями и остается легко читаемым.
Невозможно оставлять комментарии к пространствам имен.
UseNamespaceDocSummaries на http://ndoc.sourceforge.net/content/documenters.htm
При использовании системы документации mdoc Mono , вы можете задокументировать элементы пространства имен, отредактировав файлы документации ns - *. Xml.
Дополнительные сведения см. В документации по формату файла mdoc .