Project

General

Profile

Inspection » History » Revision 4

Revision 3 (Никита Артемов, 03/27/2012 02:58 PM) → Revision 4/8 (Никита Давыдовский, 03/27/2012 04:11 PM)

h1. Инспекция 

 Инспекция проведена в соответствию стилю "QML Coding Conventions":http://qt-project.org/doc/qt-4.8/qml-coding-conventions.html 

 h2. Соглашение по написанию выявленных недочетов и ошибок 

 Выявленные недочеты и ошибки перечисляются через буллеты. В конце недочёта или ошибки ставится его критичность для программы в целом. 
 * 0 - ошибка или недочёт не критичны, но следует подправить для большей структурированности и "красоты" написанного кода. 
 * 1 - ошибка или недочёт влекут за собой предупреждения при компиляции, портят общую структуру кода или влекут его неправильное понимание. 
 * 2 - ошибка или недочёт могут повлечь за собой падение программы при выполнении. 

 h2. Отчет по инспектированию 

 h3. Приложение "Places" 
 (инспектор Давыдовский Н., дата 26.03.2012) 

 * *main.qml* 
 ** строка 31: большой комментированный участок кода - 1 
 * *MainPage.qml* 
 ** строки 55, 116: комментированные участки кода - 1 
 ** строка 21: отладочная модель (List Model), следует убрать в финальной версии - 1  
 * *SearchPlacePage.qml* 
 ** нарушение порядка следования членов объекта - 0 
 ** большие участки javascript кода следует выделить в отдельные функции - 0 
 * *Header.qml* 
 ** нарушение порядка следования членов объекта - 0 
 * *Общие замечания:* 
 ** в бинарных арифметических операциях, операнды и знаки следует разделять пробелами - 0 
 ** все символьные строки явно прописанные в коде, нужно писать как аргумент функции qsTr() 
 для дальнейшего облегчения дальнейших переводов. 
 ** внутренние объекты следует разделять пробелами. 
 ** для констант (размер текста, ширина полей...) следует завести отдельный javascript  
 файл (лучше взять уже готовый, рекомендованный разработчиками фреймворка)- 1  

 

 h3. Приложение "Events" 
 (инспектор Артемов Н., дата 26.03.2012) 

 * *MainPage.qml* 
 ** строки 121-126: последовательное присваивание одной переменной разных значений - 1 
 ** строка 214, 219 : Отдельные страницы приложения типа Page следует перенести в main.qml - 1 
 * *CalendarView.qml* 
 ** наличие больших участков закомментированного кода - 0 
 * *Общие замечания:* 
 ** нарушена очередность следования объектов в файлах qml - 1 
 ** присваивание членам объектов значении по умолчанию при объявлении - 0 
 ** однотипные свойства объектов следует группировать - 0 
 ** объект с одним-двумя свойствами следует располагать на одной строке - 0 
 ** наличие магических чисел - 1