Projekt zakończony
Łukasz Rachwalski, LukaszRachwalski@gmail.com Audyt kodu, dokumentacja, uzupełenie komentarzy w kodzie w języku angielskim, testowanie. Wymagana miw08_hqedaudit.
System operacyjny dostępny jest na stronie producenta: http://ubuntu.pl/.
Producent Ubuntu http://ubuntu.pl/ udostępnił wersje programu do pobrania za pośrednictwem Menedżera pakietów Synaptic.
W celu zainstalowania poszczególnych komponentów biblioteki należy wpisać następujące komendy:
Edytor bądź środowisko programistyczne to już kwestia gustu i wygody programisty. Poniżej umieszczono jednak przykładowe aplikacje.
Następnie przystąpiono do komentowania źródeł. Proces ten przebiegał w następujący sposób. Na początku dokonano pobieżnej analizy metody w pliku cpp, a następnie na podstawie wyciągniętych wniosków komentowano nagłówek. Na słowa pochwały zasługuje autor aplikacji, który napisał kod bardzo przejrzysty oraz w dużej mierze skomentowany. Bardzo to uprościło pracę nad audytem kodu jednak nie wykluczyło przeprowadzonej analizy źródeł i potwierdzenia zapisanych informacji.
W procesie komentowania przyjęto następujące założenia:
Wszystkie komentarze plików nagłówkowych zostały zapisane w języku angielskim.
Po skomentowaniu dowolnego modułu dokonywano kompilacji całej aplikacji oraz próby jej uruchomienia. Dokonywano bowiem zmian zarówno w pliku *.cpp jak i *.h. Pracując na źródłach pobranych z repozytorium za pośrednictwem CVS wprowadzano wiele zmian. Starano się również aby kod który wysyłano z powrotem do repozytorium nie zawierał błędów.
Proces komentowania kodu przebiegał w sposób systematyczny. Na cotygodniowych konsultacjach raportowane były postępy w pracach. Ponadto uzgadniano szczegóły co do planowanych zmian.
Podczas realizacji projektu skomentowano 43 pliki nagłówkowe redagując 43 pliki cpp. Czas komentowania jednego pliku wahał się od ok. 1 godziny do 5-6 godzin. Po skomentowaniu wszystkich modułów dokonano ponownego przeglądu źródeł i niewielkich poprawek.
Program został skompilowany oraz uruchomiony na Ubuntu wersji 7.10. Dzięki uprzejmości makamin@student.agh.edu.pl do testu finalnego wykorzystano bankomat_xttml. Wszelkie potencjalne błędy, sugestie zgłaszano autorowi poprzez system raportowania błędów CVStrack.
Aplikacja została gruntownie przetestowana. Wykonano testy funkcjonalności mające na celu sprawdzenie czy program posiada funkcje umożliwiające generowanie i zarządzanie diagramami XTT. Testy te wypadły dość dobrze. Aplikacja co prawda posiada kilka niedociągnięć, są one jednak na tyle nieszkodliwe, że nie uniemożliwiają pracy w HQed. Ponadto wykonano testy polegające na wprowadzeniu dwóch systemów regułowych. Wprowadzano je od zera i generowano pliki XTT. HQed przeszedł pomyślnie również tę partię testów.
1. CVS
2. Qt
3. DoxyGen
4. Mantis Bug Trucker