Рекомендации к стилю диаграммы
Как и большинство языков программирования у Sync есть стандарт стилизации, это позволяет быстро ориентироваться в программе, а также быстро переключаться между программами от разных разработчиков.
Всегда пишите код так, будто сопровождать его будет склонный к насилию психопат, который знает, где вы живете.
Martin Golding.
Наименование
Фигуры на диаграмме имеют название Узлы или же на английском Nodes (ноды). Название основывается на том, что каждая фигура диаграммы является вершиной (узлом) соединений. Каждый узел также можно называть функцией или “черным ящиком”, так как он исполняет определенную подпрограмму, получая данные на вход и возвращая результаты на выход. К примеру, если на вход подается 2 числа, и данный узел является сумматором (сложением), то мы получаем сумму из двух чисел в выходе.
Связь между узлами называются Соединением, однако всегда можно провести аналогию с реальными устройствами и прозвать их проводами.
Диаграмма созданная из узлов называется программой или Sync-программой, так как впоследствии её можно запустить и работать с ней как с настоящей программой.
Описание узла - это дополнительная информация, которая используется в программе. Описание в Draw.io можно увидеть или добавить двойным кликом по узлу.
Шрифт и Именование переменных
Для именование переменных лучше использовать CamelCase. Также не стоит использовать слова с символом “$”. Данный символ используется в ключевых словах и при неправильном использовании может испортить работу программы.
Расположение Узлов и Соединений
Положение узлов на диаграмме не влияет на поведение программы, главное, чтоб узлы правильно были соединены. Для удобства рекомендуется использовать следующие правила:
- Последовательно используемые функции должны располагаться друг за другом.
- Одновременно используемые - друг под другом.
- Длинные линейные части программы можно разделить и расположить друг под другом.
- Операции в цикле должны располагаться под циклом.
- Пересечения соединительных линий должны понятно показывать свою принадлежность.
- Подключения в один порт, который поддерживает это, должны быть разделены.
- Отступы между узлами должны помещать в себя как минимум один узел, возможно расширение если нет места под соединения. Вертикальный отступ может быть меньше.
Стиль соединений
Для связи узлов должны использоваться соединения без стрелок, это обосновано тем, что обработчик не смотрит на них, а проверяет лишь соединены ли узлы, правильно и какие именно. Потому соединения уходящие в никуда невозможны.