Получение справки

Справочная документация для Visual Studio находится в библиотеке MSDN, которую можно установить локально на компьютер или разместить в сетевой папке. Библиотека также доступна в Интернете. Локальная версия библиотеки включает набор сжатых HTML-файлов в формате HSX. Библиотеку можно установить на компьютере полностью или частично; для полной установки библиотеки MSDN потребуется до 2 ГБ, поскольку в ней содержится документация для многих технологий Microsoft. Как локальную документацию MSDN, так и документацию в Интернете можно просматривать при помощи обозревателя справки Visual Studio – Microsoft Document Explorer.

Всего существует восемь способов доступа к документации при работе в Visual C#:

• Поиск по F1

• Поиск

• Указатель

• Содержание

• Избранные разделы справки

• Инструкции

• Динамическая справка

• Примеры

Локальная справка и справка в Интернете

На странице Параметры справки в меню Параметры можно задать следующие параметры поиска и поведения поиска F1:

• Искать сначала в библиотеке MSDN в Интернете, а затем в локальной документации, если совпадений не найдено.

• Искать сначала в локальной библиотеке MSDN, а затем в документации в Интернете, если совпадений не найдено.

• Искать только в локальной библиотеке MSDN.

Эти параметры также появятся при первом вызове поиска. В документации MSDN в Интернете могут содержаться более актуальные сведения, чем в локальной документации. Таким образом, при наличии подключения к Интернету и работе в Visual C#, рекомендуется установить параметр поиска в первую очередь в библиотеке MSDN в Интернете. Время от времени можно будет загружать обновления локальной документации.

F1 Search

F1 provides context-sensitive search capabilities. In the code editor, you can access the Help documentation for C# keywords and .NET Framework classes by positioning the cursor on or just after the keyword or class member and pressing F1. When a dialog box or any other window has the focus, you can press F1 to obtain Help for that window.

An F1 search returns no more than one page. If no match is found, an informational page that provides some troubleshooting tips is displayed.

Search

Use the search interface to return all documents that match any specified term or set of terms.

The following illustration represents the Search interface:

Поиск по f1

Функция F1 обеспечивает контекстно-зависимые возможности поиска. В редакторе кода можно получить доступ к справочной документации по ключевым словам языка C# и классам .NET Framework, если поместить курсор на ключевое слово или установить сразу после него или члена класса и нажать клавишу F1. Если фокус находится в диалоговом окне или любом другом окне, для получения справки по такому окну можно нажать клавишу F1.

Поиск по F1 возвращает не более одной страницы. Если совпадений не найдено, открывается страница со сведениями о возможном устранении неполадок.

Поиск

Для возврата всех документов, соответствующих любому заданному термину или группе терминов, используется интерфейс поиска.

На следующем рисунке показан интерфейс поиска:

You can also use the Help Options page on the Options menu to specify whether you want to search Codezone Web sites and the MSDN library. Codezone sites are run by Microsoft partners and provide useful information about C# and the .NET Framework. Codezone content is only available on the World Wide Web.

The same online versus local search options apply to both Search and F1 Search.

In the Search interface you can narrow or broaden your search by specifying what kinds of documents to include. There are three options, Language, Technology, and Topic Type. You will generally obtain the best results by checking only those options that apply to your current development scenario.

Index

The index provides a quick way to locate documents in the local MSDN library. It is not a full-text search; it searches only the index keywords that have been assigned to each document. An index lookup is generally faster and more relevant than a full-text search. If more than one document contains the index keyword that you specify in the index search box, a disambiguation window opens and enables you to select from among the possible choices.

By default, the Index window is located on the left side of Document Explorer. You can access it from the Help menu in Visual C#.

Table of Contents

The MSDN library table of contents shows all the topics in the library in a hierarchical tree view structure. It is a useful tool for browsing through the documentation to obtain an idea of what is in the library, and for exploring documents that you might not find through index or search. Often, when you find a document through F1, index, or search, you might want to know where it is located in the table of contents so that you can see what other related documentation exists for a given topic. Click the Sync with Table of Contents button in the Document Explorer toolbar to see where the currently displayed page is located in the MSDN library.

Задать область поиска (веб-узлы Codezone или библиотека MSDN) можно на странице Параметры справки, перейти к которой можно через меню Параметры. Узлы Codezone поддерживаются партнерами Microsoft и содержат полезные сведения о языке C# и платформе .NET Framework. Содержимое Codezone доступно только в Интернете.

Для обычного поиска и поиска по F1 действуют одинаковые параметры поиска в Интернете и локально.

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