Проведение процедуры code review лб 3 (на примере Java)

ID задания #S81

Теги Качество и надёжность программного обеспечения

Лабораторная работа:

Цель работы: необходимо выполнить code review для своего проекта из лабораторной работы 1(а-б). Кроме своего проекта необходимо выбрать уникальный в пределах потока Open Source проект из сайта Github на языке Java общим размером программного кода не менее 3000 строк кода (3000 loc). Для выбранного проекта провести процедуру code review.

Список критериев, по которым будет проводиться оценка качества кода:
* следование Java conventions
* Документированность публичных классов, публичных методов и интерфейсов, следование java docs
* Соблюдение Single Responsibility Principle
* Соблюдение Open Closed Principle
* Соблюдение Liskov Substitution Principle
* Соблюдение Dependency Inversion Principle
* Соблюдение Interface Segregation Principle
* Соблюдение принципа "Project Build Requires Only One Step"
* Соблюдение "Executing Tests Requires Only One Step"
* Предпочтение полиморфизму при использовании If/Else or Switch/Case
* Члены класса не хранят промежуточные данные (temporal state)
* Имена классов, методов и переменных отражают суть их предназначения
* Методы классов должны выполнять только одну задачу.
* Методы не содержать слишком большое количество входных параметров (больше 5)
* Код не содержит Magic Numbers / Strings
* Использование Exceptions вместо of Return Codes or null
* Каждый модульный тест удовлетворяет правилу AAA (arrange, act, assert)
* Каждый модульный тест изолирует класс от зависимостей.
* Names reflect what is tested, e.g. FeatureWhenScenarioThenBehaviour.
* Single Scenario per Test
* Нахождение теста в пакете совпадает с аналогичным в тестируемом классе.
Для каждого критерия необходимо оценить качество путем подсчета нарушений. Для каждого нарушения (не меньше 5) нужно привести пример кода, где нарушение было зафиксировано.

Решение (бесплатная часть):

Ход работы
1. Провёл процедуру code review (оценки качества программного кода) для проекта из лабораторной работы 1(а-б).
Нарушения:
********
2. Выбрал Open Source проект библиотеки *** на Github по адресу **.
3. Провёл code review проекта ** и выявил следующие нарушения.
Нарушения:
***

Выводы: в ходе данной лабораторной работы я провёл процедуру code review проектов лабораторной работы 1а-1б и выбранного проекта на Github. Результаты анализа проекта на Github оказались неутешительными. Были замечены многочисленные нарушения как в самом исходном коде библиотеки так и в написанных к ней тестах. Что касается моих проектов, то в процессе code review были выявлены лишь нарушения в Java coding style и организации Java Docs.

png - 1 шт.,   
       

Файлы,которые можно скачать после оплаты:

docx - 1 шт.,   
       

Страниц 13