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

Нажав горячие клавиши помощи (по умолчанию F1) или выбрав команду "Справка..." ("Help...") в меню Справка (Help), когда курсор мыши над ключевым словом или функцией PureBasic, вы откроете справку прямо на описании этого ключевого слова или функции.

Если для слова в позиции курсора в справке нет раздела, откроется главная страница указателя.

Справочник может также быть просмотрен бок о бок с исходным кодом, используя Инструмент Справки.

Быстрый доступ к справке Windows API

Есть два способа получения такого же быстрого доступа, как для функций PureBasic (по нажатию F1 при курсоре над функцией), также для функций Windows API. Чтобы включить эту возможность вам необходимо скачать дополнительные файлы справки для этих функций:

Microsoft Platform SDK The Microsoft Platform SDK предоставляет наиболее полный и актуальный на данный момент справочник программирования из имеющихся для платформы windows. Он предоставляет информацию по всем функциям api, а также обзоры и введения в различные технологии, используемые при программировании для платформы windows. Он однако довольно большой (до 400MB в зависимости от выбранных компонентов).

Для справки среды разработки вы можете установить редакцию SDK или "February 2003", или "Windows Server 2003 SP1".

Его можно скачать отсюда:
http://www.microsoft.com/msdownload/platformsdk/sdkupdate/

Учтите, что SDK также можно заказать на CD с этой страницы. Также если вы владелец любого продукта Microsoft для разработчиков (такого как Visual Studio), копия SDK может быть включена в состав одного из дисков комплекта.

Справочный файл win32.hlp Существует намного меньшего размера альтернатива полного SDK от microsoft (скачать 7.5 MB). Эта справка довольно старая (написана ещё для Windows95), так что она не предоставляет никакой информации по новым API и технологиям, внедрённым с тех пор.

Однако она предоставляет хорошую информацию об общеупотребительных API, которая всё ещё актуальна сегодня, так как в они основном не менялись. Скачать её рекомендуется, если иногда вам требуется справка по функциям API, но вы не хотите скачивать полный SDK.

Это может быть загружено отсюда:
http://www.purebasic.com/download/WindowsHelp.zip

Чтобы использовать её из среды разработки PureBasic, просто создайте поддиректорию "Help" в каталоге purebasic и скопируйте файл "win32.hlp" в неё.

Обращение к внешним файлам справки из среды разработки

Если у вас есть другие файлы справки, к которым вы хотите обращаться из среды разработки, то создайте поддиректорию "Help" в каталоге purebasic и скопируйте их в неё. Эти файлы появятся в подменю "Внешняя Справка" ("External Help") в меню Справка (Help), и в контекстном меню, которое вы открываете правым кликом в области редактирования. Файлы Chm и Hlp отображаются в программе для просмотра справки MS. Среда разработки открывает файлы справки во внутреннем просмотре файлов. Так что файлы подобные текстовым можно просмотреть таким способом непосредственно. Для других типов вы можете использовать меню Настройка инструментов, чтобы настроить внешний инструмент для обработки типа используемого вами файла справки. После этого справка отображается в том инструменте.

Например, если у вас есть файла справки pdf, настройте внешний инструмент для обработки файлов pdf и поместите файлы в поддиректорию Help каталога PureBasic. Теперь если вы кликнете файл в меню "внешняя справка" ("external help"), он будет открыт в том внешнем инструменте.