20. Отладка и тестирование проекта OpenSCADA

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

21. Правила оформления и комментирования исходных текстов OpenSCADA и его модулей

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

• отступ между уровнями вложений: 4 символа;
• размер табуляции: 8 символов;
• фигурные скобки открытия располагается на уровне предыдущей команды, если она короче 80 символов
• фигурные скобки закрытия располагается в отдельных строках;
• возможно написание вложений в одной строке с предыдущим уровнем вложения, в случае повышения читабельности кода;
• расстояние между описаниями функций не менее одного символа;
• расстояние между определением переменных и текстом программы не менее одного символа;
• допускается определение переменных в тексте при сохранении читабельности;
• избегать длины строки более 100 символов;
• команды препроцессора располагать на первом уровне вне зависимости от текущего уровня текста;
• для форматирования исходного текста, наследованного у других свободных приложений и примеров, рекомендуется использовать утилиту:

Правила комментирования исходных текстов OpenSCADA:

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

22. Условные обозначения по тексту и в исходниках

???? — сомнение в целесообразности данного участка;
?!?! — участок не полностью реализован;
!!!! — участок требует переосмысления.