123
ГЛАВА 15 – Документация и распечатка
В сравнительно простых программах, наподобие использованных в этом курсе
обучения, и написанных самим программистом, довольно просто искать ошибки
при возникновении каких-либо проблем. Однако, представьте себе программу,
состоящую из 4000 шагов, которую написал 2 года тому назад сотрудник, уво-
лившийся из компании. Без документации может оказаться почти невозможным
устранить проблемы в этой программе. Вот почему документирование является
очень важным этапом в создании программы.
Цели главы: Завершив эту главу, слушатели смогут…
o Описать 4 типа документации.
o Добавить документацию к программе.
o Описать различные опции для распечатки программы
Материалы: Руководство по обучению FX-TRN-KIT-R
GX Developer предлагает 4 типа документации: комментарии, текстовые вставки,
надписи и псевдонимы (иногда называемые "Метками операндов").
Замечание Как отмечалось выше, можно добавлять и изменять операнды и ин-
струкции, дважды щелкнув на звене или операнде. Эта функция не будет рабо-
тать, когда выбран инструмент документации. Однако, имеются и другие методы
добавления и модификации кода релейной диаграммы.
15.1 Комментарии
Комментарии присваиваются операнду, чтобы обеспечить название или
описание. Типичными комментариями для операнда ввода являются:
кнопка "Старт", "Загрузить блок связанных переменных", и т.д. Типичными
комментариями для катушки или внутреннего бита являются: "Сигнальная
лампа", "Включить двигатель 1", "Процесс разрешен" и т.д. Комментарии
могут иметь 4 строки по 8 символов, 3 строки по 5 символов или 2 строки
по 8 символов. Это устанавливается в пункте формата комментария
"Comment format" в меню View.
По умолчанию тем имеются только опции "4 * 8 символов" и "3 * 5 симво-
лов". Чтобы использовать "2 * 8 символов", перейдите в меню Tools и вы-
берите "Options". Щелкните на вкладке "Whole data" и выберите "16" из
поля со списком "Common device comment". Когда вы снова выберете
пункт "Comment format", там будут опции "2 * 8 символов" и "3 * 5 симво-
лов".
Для добавления комментария выберите "Comment" в пункте
"Documentation" в меню Edit, или щелкните на горячей клавише в инст-
рументальной панели. Выбрав инструмент создания комментария, дваж-
ды щелкните на любом операнде в релейной диаграмме и введите ком-
ментарий для операнда в открывшемся диало-
говом окне. Альтернативно, в списке данных
проекта "Project Data List" раскройте элемент
"Device comment" и дважды щелкните на поя-
вившемся элементе "COMMENT" . Этот откроет
окно списка комментариев, которые можно скопировать и вставить для
использования в любой программе электронных таблиц, например,
Microsoft Excel.