Project

General

Profile

Inspection » History » Version 4

Никита Давыдовский, 03/27/2012 04:11 PM

1 1 Никита Артемов
h1. Инспекция
2
3
Инспекция проведена в соответствию стилю "QML Coding Conventions":http://qt-project.org/doc/qt-4.8/qml-coding-conventions.html
4
5
h2. Соглашение по написанию выявленных недочетов и ошибок
6
7
Выявленные недочеты и ошибки перечисляются через буллеты. В конце недочёта или ошибки ставится его критичность для программы в целом.
8
* 0 - ошибка или недочёт не критичны, но следует подправить для большей структурированности и "красоты" написанного кода.
9
* 1 - ошибка или недочёт влекут за собой предупреждения при компиляции, портят общую структуру кода или влекут его неправильное понимание.
10
* 2 - ошибка или недочёт могут повлечь за собой падение программы при выполнении.
11
12
h2. Отчет по инспектированию
13 2 Никита Давыдовский
14
h3. Приложение "Places"
15
(инспектор Давыдовский Н., дата 26.03.2012)
16
17
* *main.qml*
18
** строка 31: большой комментированный участок кода - 1
19
* *MainPage.qml*
20
** строки 55, 116: комментированные участки кода - 1
21
** строка 21: отладочная модель (List Model), следует убрать в финальной версии - 1 
22
* *SearchPlacePage.qml*
23
** нарушение порядка следования членов объекта - 0
24
** большие участки javascript кода следует выделить в отдельные функции - 0
25
* *Header.qml*
26
** нарушение порядка следования членов объекта - 0
27
* *Общие замечания:*
28
** в бинарных арифметических операциях, операнды и знаки следует разделять пробелами - 0
29
** все символьные строки явно прописанные в коде, нужно писать как аргумент функции qsTr()
30 4 Никита Давыдовский
для облегчения дальнейших переводов.
31 1 Никита Артемов
** внутренние объекты следует разделять пробелами.
32 4 Никита Давыдовский
** для констант (размер текста, ширина полей...) следует завести отдельный javascript 
33
файл (лучше взять уже готовый, рекомендованный разработчиками фреймворка)- 1 
34 3 Никита Артемов
35
h3. Приложение "Events"
36
(инспектор Артемов Н., дата 26.03.2012)
37
38
* *MainPage.qml*
39
** строки 121-126: последовательное присваивание одной переменной разных значений - 1
40
** строка 214, 219 : Отдельные страницы приложения типа Page следует перенести в main.qml - 1
41
* *CalendarView.qml*
42
** наличие больших участков закомментированного кода - 0
43
* *Общие замечания:*
44
** нарушена очередность следования объектов в файлах qml - 1
45
** присваивание членам объектов значении по умолчанию при объявлении - 0
46
** однотипные свойства объектов следует группировать - 0
47
** объект с одним-двумя свойствами следует располагать на одной строке - 0
48
** наличие магических чисел - 1