XML-комментарии Intellisense Отдельный файл распознается как существующий, но не отображается во всплывающей подсказке - PullRequest
Новая
       21

XML-комментарии Intellisense Отдельный файл распознается как существующий, но не отображается во всплывающей подсказке

0 голосов
/ 06 марта 2019

Проблема, с которой я сталкиваюсь, заключается в том, что документация должна находиться в отдельном файле, но все равно выдает результаты тега <summary> в подсказке Intellisense.

У меня есть комментарии в отдельном файле, и у меня установлена ​​опция сборки документов XML. В случае, когда я использую тег <include> с комментариями в отдельном файле, и когда я пишу комментарии XML в источнике, генерируется тот же файл выходного документа. В обоих случаях файл документа называется так же, как сборка, и в том же каталоге, как указано MSDN.

Когда комментарии находятся в отдельном файле, VS разрешает их, потому что предупреждение Missing XML comment for... исчезает при добавлении тега <include>.

Однако, только в случае, когда комментарии XML написаны в источнике, они включаются во всплывающую подсказку.

Например: 

///<summary>Class that frobnicates things</summary>
public Frobnicator
{
    ///<summary>Causes frobnication</summary>
    public void Frobnicate(object thing)
    {
    }
}

и 

///<include file='docs.xml' path='correctlyResolvedXPATHquery' />
public class Frobnicator
{
    ///<include file='docs.xml' path='correctlyResolvedXPATHquery' />
    public void Frobnicate(object thing)
    {
    }
}

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

Тогда возникает вопрос: что мне нужно сделать, чтобы комментарии были в отдельном файле и отображаются во всплывающей подсказке? Какой шаг или параметр конфигурации мне не хватает?

...