Принципы создания алгоритма

В данном материале рассматриваются основные принципы создания алгоритма в платформе "ElectroNeek"

Введение

Для разработки алгоритма робота необходимо открыть программу "ElectroNeek DevTool". При открытии "ElectroNeek DevTool" автоматически запускается программа "ElectroNeek Agent", которая используется для того, чтобы выполнить разработанный пользователем алгоритм.

Здесь и далее для краткости будут использоваться сокращения "DevTool" и "Agent" для "ElectroNeek DevTool" и "ElectroNeek Agent" соответственно.

Интерфейс

На рисунке ниже представлен интерфейс программы "DevTool".

Вид интерфейса программы "DevTool"

Цифры на рисунке означают следующее:

  1. Группа кнопок для сохранения, открытия и создания нового файла с алгоритмом.

  2. Блок с функциями, сгруппироваными по принципу того, что эти функции позволяют автоматизировать.

  3. Кнопка запуска алгоритма. В момент работы алгоритма рядом отображается кнопка остановки алгоритма.

  4. Путь к открытому файлу с алгоритмом (если создать новый алгоритм и не сохранить его, что вместо пути отображается фраза "Новый файл", как на рисунке выше).

  5. Слева-направо: кнопки смены языка программы, информация о текущем аккаунте, логотип платформы (при клике на него открывается документация).

  6. Свойства выбранной функции: ее описание и параметры.

  7. Блок с переменными, в котором после работы робота отображаются все переменные, инициализированные в данном алгоритме.

  8. Консоль, где появляются сообщения о статусе работы робота.

  9. Рабочее пространство, куда добавляются и соединяются между собой блоки.

Алгоритм

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

Также разнообразить код и сделать его более функциональным можно путем добавления выражений на языке JavaScript. В частности, можно использовать функцию "Выполнить код", которая позволяет создать некоторый последовательный алгоритм на языке JavaScript.

Все переменные (кроме тех, которые созданы внутри блока "Выполнить код") являются глобальными и сохраняются в текущем аккаунте. То есть эти переменные доступны из любого файла ".neek" и из любого блока.

Если пользователь создал переменную внутри блока "Выполнить код", то вне этого блока та переменная не будет доступна.

Блок

Для добавления блока в рабочую область из панели слева необходимо либо дважды кликнуть по наименованию функции, либо перетащить блок при помощи drag'n'drop.

Для задания параметров блока необходимо щёлкнуть левой кнопкой мыши по блоку. Окно с параметрами находится на вкладке "Свойства блока" справа. Красной звездой отмечены те параметры, которые обязательны для заполнения. Также каждый блок содержит поле "Комментарий". Это поле позволяет дать описание текущему блоку, чтобы впоследствии было проще понять, что делает данная функция в алгоритме.

Пример параметров функции "Отправить письмо"

Если блок подсвечивается зеленым цветом, то это значит, что все необходимые параметры заполнены. Если блок подсвечивается желтым цветом, то это значит, что некоторые необходимые параметры были не заполнены.

Каждый блок содержит по крайней мере два порта (варианта продолжения). Ветка, идущая из зеленого порта, соответствует успешному результату выполнения данного блока. Ветка, идущая из красного порта "Ошибка", срабатывает в том случае, если в момент выполнения блока произошло какое-либо исключение. Блоки логического характера имеют три порта: "Да", "Нет" и "Ошибка".

Блоки можно перемещать, удалять и копировать. Возможно выделить несколько блоков, удерживая клавишу "Ctrl" и нажимая левой кнопкой мыши по желаемым блокам. Несколько блоков одновременно можно удалить, переместить, копировать и вставить.

Советы

При разработке алгоритма рекомендуется придерживаться следующих практик:

  1. Разбивать одну большую программу на различные подпрограммы, исходя из смысла, целей и логики алгоритма. Это позволит лучше видеть структуру алгоритма, проще понимать его суть и легче вносить изменения.

  2. Стараться делать алгоритм аккуратным и читаемым. Для этого рекомендуется удалять "лишние" блоки, то есть те блоки, которые использовались для отладки и которые не несут в себе практической пользы. Также рекомендуется вносить комментарии в блоки или использовать блок "TODO" для того. Это особенно полезно, если над алгоритмом работают несколько человек. В таком случае наличие осмысленных комментариев позволит лучше и быстрее ориентироваться в коде.

  3. Давать подпрограммам и переменным читаемые названия. Название переменной должно четко отражать ее смысл, то же касается названия подпрограмм. Также существуют различные устоявшиеся виды нотаций (некоторые примеры приведены в таблице ниже), и в алгоритме рекомендуется придерживаться единой нотации.

Название нотации

Пример

Верблюжья

ListOfContragents

Змеиная

list_of_contragents

Венгерская

arrListOfContragents