Reguła jest konkretnym wyrażeniem opisującym wybrany aspekt pisania kodu. Oto przykładowe reguły związane z przeglądem kodu:
Reguły stanowią podstawę konfiguracji analizy. Proces analizy polega na sprawdzeniu, czy zasoby spełniają wymagania określonej reguły lub zestawu reguł. Można modyfikować istniejące reguły oraz tworzyć własne, jeśli konieczne jest lepsze dostosowanie reguł do konkretnych wymagań projektowania aplikacji. Reguły wymienione wcześniej należą na przykład do kategorii zasad projektowych. Reguły dotyczące podobnych możliwości lub struktur kodu należą do tej samej kategorii. W zależności od celu danego przeglądu można stosować reguły z wielu kategorii.
Twórcy reguł przypisują każdej regule poziom istotności określający, jak poważnie zasób naruszający regułę odbiega od przyjętych standardów. Każda reguła ma przypisany jeden z następujących poziomów istotności:
Ikona | Poziom istotności | Opis |
---|---|---|
![]() |
Zalecenie | Jest to najniższy poziom istotności. Wynik na takim poziomie sygnalizuje problem, który nie jest poważny, ale którego możliwie najszybsze naprawienie jest wskazane. |
![]() |
Ostrzeżenie | Poziom istotności sygnalizujący, że najprawdopodobniej wystąpił problem z zasobem wymagający rozwiązania. |
![]() |
Istotne | Jest to najwyższy poziom istotności. Wystąpienie wyniku o tym poziomie sygnalizuje konieczność rozwiązania problemu opisanego w wyniku. |
Zalecenia mają wprawdzie najniższy poziom istotności, ale wynikom na tym poziomie również należy poświęcić uwagę. Nawet jeśli nie sygnalizują one faktycznych problemów, to wskazują źródła potencjalnych problemów w przyszłości. Reguły stworzono w oparciu o zestaw sprawdzonych procedur i standardów branżowych, których zespoły programistyczne powinny przestrzegać.
Dostawcy analizy to komponenty środowiska analizy implementujące grupy narzędzi, które zawierają kategorie. Można wybierać różnych dostawców do różnych rodzajów analizy, a w zależności od konkretnych potrzeb analizy można też włączać lub wyłączać kategorie reguł i zawarte w nich wybrane reguły.
Przykładem kategorii reguł jest stosowana przy przeglądach kodu kategoria wydajności. Wydajność jest istotnym aspektem jakości aplikacji, więc powinna być jedną z cech badanych podczas przeglądu kodu. Kategoria reguł wydajności zawiera trzy podkategorie (pamięć, profilowanie i szybkość), z których każda zawiera zestaw reguł stosowanych do kodu źródłowego w chwili rozpoczęcia analizy wykorzystującej tę kategorię.