Отладка и тестирование проекта OpenSCADA
Для контроля за качеством кода и проверки работоспособности различных участков системы пишутся специальные модули выполняющие процедуру тестирования с выдачей протокола тестирования. Данные модули необходимо выполнять после завершения работы над любым участком проекта.
Правила оформления и комментирования исходных текстов OpenSCADA и его модулей
При написании и оформлении исходных текстов системы OpenSCADA и его модулей необходимо придерживаться следующих правил:
- отступ между уровнями вложений: 4 символа;
- Фигурные скобки открытия и закрытия должны располагаться в отдельных строках на уровне предыдущего текста;
- возможно написание вложений в одной строке с предыдущим уровнем вложения, в случае повышения читабельности кода;
- растояние между описаниями функций не менее одного символа;
- растояние между определением переменных и текстом программы не менее одного символа;
- допускается определение переменных в тексте при сохранении читабельности;
- избегать длины строки более 100 символов;
- команды препроцессора располагать на первом уровне вне зависимости от текущего уровня текста;
- для форматирования исходного текста наследованного у других свободных приложений и примеров рекомендуется использовать утилиту:
indent -bli0 -i4 -l100 -npsl -npcs -prs -nsaf -nsai -ts8 <filename>.
Правила комментирования исходных текстов OpenSCADA:
- обязательному комментированию и тщательному описания подлежат объявления классов;
- объявления публичных методов классов должны быть тщательно описаны с индивидуальным описанием каждого параметра;
- объявления публичных атрибутов также необходимо тщательно комментировать;
- текст функций не нуждаются в тщательном комментировании, однако тонкие и неявные места желательно комментировать.
Условные обозначения по тексту и в исходниках
???? -- сомнение в целесообразности данного участка;
?!?! -- участок не полностью реализован;
!!!! -- тонкое место, участок требует переосмысления.