Visual Studio показывает документы при нажатии Ctrl + Пробел - PullRequest
2 голосов
/ 29 июня 2011

Почему-то я вижу документы только для .net библиотек. Есть ли способ просмотреть мои или сторонние документы в Visual studio?

Я хотел бы знать, возможно ли просматривать документы при нажатии Ctrl + пробел в Visual Studio 2010. Похоже на то, к чему я привык в Eclipse :). Или, по крайней мере, при нажатии (выборе) на метод или класс, чтобы иметь возможность видеть документы в каком-либо виде (окне)?

Ответы [ 2 ]

4 голосов
/ 29 июня 2011
  1. Создание XML-документации путем включения соответствующей опции в свойствах проекта (вкладка «Сборка»)

  2. Поместите полученный XML-файл в ту же папку, что и DLL

3 голосов
/ 29 июня 2011

Под "документами" я предполагаю, что вы имеете в виду подсказку Intellisense? Эта подсказка будет включать документацию XML, если таковая существует для метода. Документация XML на C # описана в MSDN. Чтобы добавить сводную документацию к методу, вы добавляете специальный комментарий с префиксом ///:

public class Foo {

  /// <summary>
  ///   Bars the foo.
  /// </summary>
  public void Bar() {
  }

}

В VB.Net вы можете использовать тот же XML, но в качестве специального символа комментария придется использовать ''' вместо ///.

Вам нужно будет скомпилировать сборку, используя опцию /doc. Вы можете включить его в свойствах проекта:

Enabling generation of XML documentation in project properties

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

...