Сводка не отображается в сборке, если она добавлена ​​в качестве ссылки - PullRequest
39 голосов
/ 25 июня 2011

Я создал «Библиотеку классов» в C #, которая имеет много функций со сводкой (комментарии к документации XML).

Например

///<summary>
///Adds the two numbres
///</summary>
public void Add()
{
    //statements
}

если я использую функцию в том же пространстве имен, она отображает сводку, но если я добавила ее в качестве ссылки в другое рабочее пространство (решение), ее сводка не отображается.

Как сделать это видимым в других решениях, если добавить его в качестве ссылки, и ват может быть причиной этого?

Ответы [ 3 ]

45 голосов
/ 29 ноября 2012
  1. Перейдите в обозреватель решений вашего исходного кода. Щелкните правой кнопкой мыши имя проекта и выберите свойства .
  2. перейдите на вкладку Build , если вы используете c #, и установите флажок Файл документации XML .
  3. Когда вы создаете свой исходный код, файл XML будет сгенерирован в том месте, где присутствует ваша dll.
  4. пока копируете dll в решение, скопируйте файл xml и вставьте его в корзину вашего целевого решения.
41 голосов
/ 25 июня 2011

Вам необходимо сгенерировать документацию XML для сборки (файл с именем myassembly.xml) и скопировать ее вместе с вашим .dll, где на него ссылаются другие ваши проекты.См. эту страницу в MSDN для получения инструкций.

2 голосов
/ 25 июня 2011

Когда вы компилируете классы с комментариями xml, обычно создается файл .xml. (проверьте параметры в Visual Studio)

Когда вы добавляете ссылку на такую ​​сборку, убедитесь, что файл XML присутствует. Документация содержится не в сборке, а в файле xml.

...