Урок 3 Создание ВП

C. Документирование кода

Профессиональные разработчики, которые занимаются сопровождением и модификацией ВП, знают цену хорошей документации. Документируйте блок-диаграмму, чтобы облегчить модификацию кода в будущем. Документируйте лицевую панель, чтобы было понятно назначение ее объектов и ВП в целом.

К средствам документирования лицевой панели относятся всплывающие подсказки, описания, свойства ВП, а также хороший дизайн.

Всплывающие подсказки

Всплывающая подсказка (tip) — это комментарий, который появляется при наведении курсора мыши на элемент управления или индикатор. Например, подсказка может сообщать, что температура измеряется в градусах Цельсия, или объяснять, каким образом входные данные используются в алгоритме. Дополнительная информация об элементах управления или индикаторах содержится в их описаниях. Чтобы добавить подсказку и/или описание, выберите в контекстном меню элемента пункт

Description and Tip.

Свойства ВП

Компонент Documentation диалога VI Properties позволяет создавать описания ВП и связывать их с HTML-файлами или компилированными справочными файлами (.chm). Для вызова диалога свойств щелкните правой кнопкой на иконке ВП в окне лицевой панели или блок-диаграммы и выберите в контекстном меню VI Properties. Можно также выбрать пункт меню File>>VI Properties. Затем выберите Documentation в раскрывающемся меню Categories. Во время выполнения ВП этот диалог недоступен.

На странице диалога находятся следующие компоненты.

•VI description. Содержит текст, который появляется в окне контекстной справки при нахождении курсора над иконкой ВП. Любую часть описания можно выделить полужирным шрифтом с помощью тегов <B> и </B>. Описание ВП можно редактировать программно, обращаясь к свойству VI Description.

•Help tag. Содержит имя HTML-файла или ключевое слово для индексного поиска темы в компилированного справочном файле. Тег справки можно установить программно, используя свойство

Help:Document Tag.

•Help path. Содержит путь к HTML-файлу или компилированному справочному файлу, на который вы хотите сослаться из окна контекстной справки. Если это поле оставлено пустым, синяя ссылка Detailed help не появится в окне контекстной справки, а кнопка More Help будет затенена. Путь к справке можно задать программно, используя свойство

Help:Document Path.

Урок 3 Создание ВП

•Browse. Открывает диалог для перехода к HTML-файлу или компилированному справочному файлу в дереве каталогов. Полученный таким образом путь будет использоваться в свойстве Help path.

Именование элементов управления и индикаторов

Логичные и описательные имена элементов управления и индикаторов повышают удобство пользования лицевой панелью. Например, если вы назвали элемент управления Temperature, пользователь может не догадаться, какие единицы измерения использовать. Имя Temperature °С повысит информативность лицевой панели. Теперь сразу понятно, что температура вводится в

градусах Цельсия.

Графическое программирование

Хотя графическая природа LabVIEW способствует самодокументированию блок-диаграмм, дополнительные комментарии будут нелишними, если в будущем предполагается модифицировать ВП. На блок-диаграмме могут быть комментарии двух типов: комментарии, которые описывают функцию или операцию алгоритма, и комментарии, которые объясняют назначение данных, передаваемых по проводникам. Оба типа комментариев показаны на блок-диаграмме рис. 3-13. Метки можно вставлять инструментом ВВОД ТЕКСТА или через палитру

Functions>>All Functions>>Decorations. По умолчанию свободные метки имеют желтый фон.

Рис. 3-13. Документирование блок-диаграммы.

При написании комментариев к ВП придерживайтесь следующих правил.

•Комментарии на блок-диаграмме должны объяснять, что делает код.

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

•Не показывайте метки на функциях и подВП, поскольку это загромождает код. Разработчик, который будет просматривать блок-диаграмму, определит имя функции или подВП при помощи окна контекстной справки.

Урок 3 Создание ВП

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

•Подписывайте структуры, чтобы объяснить их основное назначение.

•Подписывайте константы, чтобы объяснить их происхождение.

•Используйте свободные метки для документирования алгоритмов, реализованных на блок-диаграмме. Если алгоритм взят из книги или другого источника, приведите ссылку на этот источник.