Страницы

Поиск по вопросам

вторник, 20 ноября 2018 г.

Как пользоваться справкой VisualStudio

Существует много простых вопросов, на которые можно ответить ссылкой или примером кода взятыми из официальной документации Microsoft. Судя по тому, что количество таких вопросов неуклонно растет, не все знают о существовании встроенной в студию справочной системы, а если и знают, то не умеют быстро и удобно ей пользоваться.
Здесь постараемся раскрыть тонкости использования справочной системы студии.


Ответ

Т.к. читать сегодня тоже не очень модно, начну с главного, как быстро получить интересующую информацию.
В десктопных приложениях, исторически сложилось, что клавиша F1 служит для вызова справки. VisualStudio также использует эту клавишу для работы со справкой, но в более широком смысле. Если вас интересует справка по какому то классу, методу и или функции поставляемым в библиотеках Microsoft, достаточно поставить текстовый курсор (выделять полностью не обязательно) в редакторе кода на имя интересующего элемента и нажать F1. VisualStudio автоматически создаст поисковый запрос к справочной системе и откроет соответствующий раздел справки, если такой имеется в наличии.
Microsoft предоставляет два варианта справки доступной напрямую из IDE: online и offline. В настоящее время, визуальное представление Online и Offline версий практически не отличается. Слева навигация по дереву разделов документации, справа - навигация по разделам статьи.
Качество документации:
Сначала о хорошем:
в той или иной степени документировано все. много рабочих примеров кода, некоторые из которых довольно часто используются практически без изменений и дополнений в рабочих проектах. есть пошаговые инструкции для выполнения типовых задач, таких как, например, чтение и запись файлов, создание простых оконных приложений, создание простых сервисов и т.д.
Ну и о плохом:
если есть возможность, то лучше читать документацию на оригинальном английском, т.к. с некоторых пор MSDN использует систему автоматического перевода для локализации, что негативно сказывается на качестве локализованных текстов. присутствуют некоторые неточности и неоднозначности в оригинальной версии. отдельные разделы документированы весьма условно (камень в огород WinAPI и еще некоторых).
Но не смотря на все недостатки не очень хорошая документация однозначно лучше чем ее полное отсутствие.
Offline вариант можно установить вместе с VisualStudio или добавить позже. Важная особенность Offline-справки - ее можно загружать частями, по мере необходимости. Установка локального содержимого и управление им. Сразу хочу предупредить, что полный объем справочной информации превышает несколько десятков гигабайт и это только для .NET, так что это не быстрый процесс, но в результате вы сможете искать информацию независимо от наличия выхода в сеть.

Комментариев нет:

Отправить комментарий