Project

General

Profile

Inspection » History » Revision 5

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

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