МЕНЮ
Рекомендации по разработке роботов в PIX Studio
1. Декомпозиция
Идеальная структура проекта выглядит следующим образом: в корне папки располагается один управляющий скрипт main.pix. Остальные скрипты разносятся по отдельным папкам, наименования которых, отражают зону действия скрипта: к примеру папка «1С», «Oracle», «web» и т.д.
Идеальная структура проекта выглядит следующим образом: в корне папки располагается один управляющий скрипт main.pix. Остальные скрипты разносятся по отдельным папкам, наименования которых, отражают зону действия скрипта: к примеру папка «1С», «Oracle», «web» и т.д.
2. Модульность
Один скрипт должен отражать только одно логическое действие. Например: войти в базу 1С, выгрузить отчеты, создать документ реализации. Такое разделение позволяет многократно использовать уже существующие скрипты в других проектах.
Один скрипт должен отражать только одно логическое действие. Например: войти в базу 1С, выгрузить отчеты, создать документ реализации. Такое разделение позволяет многократно использовать уже существующие скрипты в других проектах.
3. Комментарии
Для упрощения понимания логики скрипта необходимо добавлять комментарии .
Для упрощения понимания логики скрипта необходимо добавлять комментарии .
4. Учётные данные
Нельзя хранить пароли в роботе в явном виде. Учётные данные необходимо хранить в «Windows credentials» или в сторонних системах (SQL, key pass и пр.).
Нельзя хранить пароли в роботе в явном виде. Учётные данные необходимо хранить в «Windows credentials» или в сторонних системах (SQL, key pass и пр.).
5. Параметры скрипта
Именуются параметры верхней нотацией CamelCase. Для удобства, в именах параметров скрипта можно использовать префиксы, которые подсказывают пользователю о назначении параметра.
Например:
In_ - входящий параметр;
Out_ - исходящий параметр.
Имена параметров должны быть понятными.
Именуются параметры верхней нотацией CamelCase. Для удобства, в именах параметров скрипта можно использовать префиксы, которые подсказывают пользователю о назначении параметра.
Например:
In_ - входящий параметр;
Out_ - исходящий параметр.
Имена параметров должны быть понятными.
6. Локальные переменные
В переменных, созданных и используемых в реализации скрипта необходимо использовать нижнюю camelCase нотацию. Наименования переменных должны быть легко читаемыми и связанными по смыслу с выполняемыми операциями.
В переменных, созданных и используемых в реализации скрипта необходимо использовать нижнюю camelCase нотацию. Наименования переменных должны быть легко читаемыми и связанными по смыслу с выполняемыми операциями.
7. Критические участки
Участки проекта, где возможны возникновения исключений должны быть обернуты оператором Try\Catch.
Участки проекта, где возможны возникновения исключений должны быть обернуты оператором Try\Catch.
8. Исключения
При использовании активности «Вызвать исключение» необходимо подробно, но лаконично описать состав ошибки.
При использовании активности «Вызвать исключение» необходимо подробно, но лаконично описать состав ошибки.
9. Информация о ресурсах
Такую информацию требуется выносить в отдельный конфигурационный файл (txt; xlsx). В нём можно хранить изменяемые данные, такие как: URL-адреса, пути к файлам и т.д.
Такую информацию требуется выносить в отдельный конфигурационный файл (txt; xlsx). В нём можно хранить изменяемые данные, такие как: URL-адреса, пути к файлам и т.д.
10. Адресация
В роботе следует избегать абсолютных путей к файлам и папкам. Лучше использовать относительные пути.
В роботе следует избегать абсолютных путей к файлам и папкам. Лучше использовать относительные пути.
