Как использовать встроенные комментарии для членов документа в .NET?

Question

Как я могу документально зарегистрировать члена в .Net? Позволь мне объяснить. Большинство инструментов, которые извлекают документацию из комментариев, поддерживают некоторую встроенную документацию, куда вы можете добавить краткое описание после объявления участника. Что-то вроде:

public static string MyField; /// <summary>Information about MyField.</summary>

Есть ли способ сделать это на языках C # или .NET?

Answer 1

Нет, вы не можете. Комментарии XML поддерживаются только как комментарии уровня блока, то есть они должны быть помещены перед документируемым элементом кода. Обычные инструменты для извлечения комментариев XML из кода .NET не понимают, как анализировать встроенные комментарии подобным образом. Если вам нужна эта способность, вам нужно написать свой собственный парсер.

Answer 2

Нет встроенного способа сделать это. Система документации XML является иерархической; он определяет взаимосвязь между тегом <summary /> и данными, которые непосредственно следуют за ним.

Answer 3

Да, просто поставьте это ДО того, что вы хотите прокомментировать

/// <summary>Information about MyField.</summary>
public static string MyField;