--- pl:miw:miw08_hqedaudit [2008/05/27 20:14]
lrachwalski
+++ pl:miw:miw08_hqedaudit [2019/06/27 15:50] (aktualna)
@@ Linia 1: / Linia 1: @@
 ====== HQedAudit ======
+__**Projekt zakończony**__
 Łukasz Rachwalski, <LukaszRachwalski@gmail.com>
 **Audyt kodu**, dokumentacja, uzupełenie komentarzy w kodzie w języku angielskim, testowanie. Wymagana [[pl:miw:miw08_hqedaudit]].
 ====== Spotkania ======
+[[https://ai.ia.agh.edu.pl/wiki/pl:miw:miw08_hqedaudit:spotkania|Konsultacje]]
-===== 08.02.26 =====
+====== Projekt ======
-  * dostęp do charona i cvs, budowanie hqed
-  * zaznajomienie się z: qt, <del>[[http://www.cvstrac.org|CVStrac]]</del>, doxygen
-===== 08.03.04 =====
-  * zaznajonienie się z [[http://www.mantisbt.org/|manits]] [[http://www.mkgnu.net/?q=scmbug|scmbug]]
-  * viewvc, mantis
-===== 08.03.11 =====
-  * wdrożenie do pracy z narzędziami
-===== 08.03.18 =====
-  * przejrzeć kod [[student:hqed|HQEd]]
-  * wygenerować o siebie lokalnie dokumentacje doxygen
-  * dopisywać brakujące komentarze -> //po ang//
-  * zmiana komentarzy na angielski!
-  * testowanie HQed... -> zgłaszanie bugów (trac)
-===== 08.04.01 =====
-  * uporządkować dokumentację w wiki
-  * zgłaszać uwagi ogólne
-===== 08.04.15 =====
-  * pytania?
-===== 08.05.27 =====
-  * test dostępu do trac
-  * sprawozd: co zostało zrobione, statystyka, ile gdzie komentarzy etc., co nie skoment, wskazówki, uwagi co do koemntowania i doxygen
-  * próba audytu hqed poprzez realizację przykładów z https://ai.ia.agh.edu.pl/wiki/pl:miw:miw08_ardcase_cs#control_system_models
-  * w szczeg.: https://ai.ia.agh.edu.pl/wiki/pl:miw:miw08_ardcase_cs:bankomat i https://ai.ia.agh.edu.pl/wiki/pl:miw:miw08_ardcase_cs:biletomat
-  * proces
-    - plik .pl dla vardy od p. Kamińskiego
-    - ./varda bankomat-model.pl
-    - gax.
-    - xxg('bankomat.xttml').
-    - w hqed load w.w
-    - mamy puste tabele
-    - czytamy opis systemu od p. Kamińskiego
-    - tworzymy reguły w tablicach
-    - raportujemy błędy hqed/varda/pKam do cvstrac
-    - spisujemy ew. inne uwagi na str. projektu
-===== 08.06.03 =====
-  * impl przykładów z [[pl:miw:miw08_xtt_serialization]]
-====== Projekt ======
 ===== Główne cele projektu ====
-  * Uzupełnić dokumentację w kodzie HQed i w wiki.
+  - Postawić środowisko uruchomieniowe dla HQed, CVS, DoxyGen.
-  * Przeprowadzić serię testów aplikacji.
+  - Uzupełnić dokumentację w kodzie HQed i w wiki.
+  - Przeprowadzić serię testów aplikacji.
 ===== Co się udało osiągnąć? =====
@@ Linia 78: / Linia 26: @@
     * Poszerzyć znajomość DoxyGen - używanie wyłącznie konsoli, budowa pliku konfiguracyjnego .cfg, generowanie dokumentacji.
     * Zapoznanie się z obsługą systemu Mantis Bug Tracker - zalogowanie do projektu DEMO, poznanie podstawowych operacji na projektach, poznanie terminologii systemu i sposobu jego działania.
+    * Postawić kompletne środowisko uruchomieniowe.
-====== Środowisko pracy ======
-  * System operacyjny: Linux - Ubuntu ver. 7.10.
-  * Concurrent Versions System (CVS) ver. 1.12.13.
-  * Biblioteka Qt ver. 4
-  * DoxyGen ver. 1.5.3
-  * Mantis Bug Tracker
+====== Kompletne środowisko uruchomieniowe ======
-===== Konfiguracja poszczególnych komponentów - Linux =====
+===== W skład kompletnego środowiska uruchomieniowego wychodzą: =====
+  - System operacyjny: Linux - Ubuntu ver. 7.10.
+  - Concurrent Versions System (CVS) ver. 1.12.13.
+  - Biblioteka Qt ver. 4
+  - DoxyGen ver. 1.5.3
+  - Mantis Bug Tracker
+  - HQed
+===== Konfiguracja poszczególnych komponentów =====
+==== Ubuntu ver. 7.10 ====
+System operacyjny dostępny jest na stronie producenta: [[http://ubuntu.pl/]].
 ==== Concurrent Versions System 1.12.13 ====
@@ Linia 109: / Linia 65: @@
 Źródło powyższych informacji to: [[http://www.clivecooper.co.uk/tutorial/index.html]].
 ==== DoxyGen 1.5.3 ====
 Producent Ubuntu [[http://ubuntu.pl/]] udostępnił wersje programu wraz z dokumentacją oraz nakładką graficzną do pobrania za pośrednictwem Menedżera pakietów Synaptic.
 ==== Mantis Bug Trucker 1.1.1 ====
@@ Linia 120: / Linia 74: @@
+====== Komentowanie źródeł projektu ======
-====== Komentowanie źródeł projektu HQEd ======
+===== Struktura katalogowa projektu =====
+Założono, że komentowniu podlegają tylko te moduły, które znajdują się w katalogach o nazwie XTT. Poniższy schemat zawiera podział katalogowy aplikacji HQed.
-==== Struktura katalogowa projektu ====
   Hqed
    |--C
       |--ARD
-      |--XTT  /// katalog wymaga komentowania
+      |--XTT  /// zawiera moduły do skomentowania
       M
       |--ARD
-      |--XTT  /// katalog wymaga komentowania
+      |--XTT  /// zawiera moduły do skomentowania
       V
       |--ARD
-      |--XTT  /// katalog wymaga komentowania
+      |--XTT  /// zawiera moduły do skomentowania
-==== Założenia dotyczące wstawiania komentarzy ====
+===== Założenia dotyczące wstawiania komentarzy =====
     * Styl komentowania w [[http://www.stack.nl/~dimitri/doxygen/docblocks.html|DoxyGen]]: JavaDoc.
     * Komentowane są tylko pliki nagłówkowe.
     * Język komentarzy to angielski.
+===== Skomentowane moduły =====
+    * Kompletna dokumentacja projektu HQed znajduje się [[https://hekate.ia.agh.edu.pl/webdoxy/hqed/doc/|tutaj]].
-==== Skomentowane moduły ====
+===== Podsumowanie =====
-    * [[https://hekate.ia.agh.edu.pl/webdoxy/hqed/doc/|Dokumentacja projektu]]
+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.
-====== Testowanie ======
+====== Testowanie aplikacji ======
 Testy przeprowadzono na przykładach zaczerpniętych z [[pl:miw:miw08_xtt_serialization]].
-===== Wyniki testów =====
+===== Test Funkcjonalności Aplikacji HQed =====
+Testy funkcjonalności znajdują się {{:pl:miw:protokul_testu_hqed.pdf|tutaj}}.
+===== Test 1 - Cennik biletów na wyciąg narciarski =====
+  - Wygenerowany Xttml: {{:pl:miw:wyciag_narciarski.xttml|Wyciag_narciarski.xttml}}.
+  - Uwagi:
+  * program czasem błędnie interpretuje typ enumerate
+  * program nie posiada możliwości wprowadzenia operatora: ALL oraz ANY w edycji komórki
+===== Test 2 - Ceny biletów na pociąg =====
+  - Wygenerowany Xttml: {{:pl:miw:bilety_na_pociag.xttml|Bilety_na_pociag.xttml}}.
+  - Uwagi:
+  * program czasem błędnie intrpretuje wprowadzony typ enumerate
+===== Podsumowanie =====
+Aplikacja została dość szczegółowo przetestowana. Wynik testów jest jednak pozytywny. Program działa dobrze, jest stosunkowo stabilny a istniejące błędy są jedynie niedociągnięciami których usunięcie nie powinno być kosztowne.
 ====== Podsumowujące sprawozdanie z projektu ======
@@ Linia 179: / Linia 148: @@
 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 Marcina Kmińskiego <makamin@student.agh.edu.pl> do testu finalnego wykorzystano [[https://ai.ia.agh.edu.pl/wiki/_media/pl:miw:miw08_ardcase_cs:cashpoint-xttml_v3.xttml?id=pl%3Amiw%3Amiw08_ardcase_cs%3Abankomat&cache=cache|bankomat_xttml]].
+Program został skompilowany oraz uruchomiony na Ubuntu wersji 7.10. Dzięki uprzejmości <makamin@student.agh.edu.pl> do testu finalnego wykorzystano [[https://ai.ia.agh.edu.pl/wiki/_media/pl:miw:miw08_ardcase_cs:cashpoint-xttml_v3.xttml?id=pl%3Amiw%3Amiw08_ardcase_cs%3Abankomat&cache=cache|bankomat_xttml]].
 Wszelkie potencjalne błędy, sugestie zgłaszano autorowi poprzez system raportowania błędów [[https://hekate.ia.agh.edu.pl/webtrac/hades/trac.vc|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.
 ====== Materiały pomocnicze ======

pl/miw/miw08_hqedaudit.1211912088.txt.gz · ostatnio zmienione: 2019/06/27 15:58 (edycja zewnętrzna)

Pokaż stronę Poprzednie wersje

Menadżer multimediów Do góry

AIwiki

Menu

Dla Studentów

Old specialized AI courses

SMaDA/SMaIDA/AIDA

Informatyka (EAIiIB)

Studia Dr

Inne materialy dydaktyczne

Archiwum

Dyplomanci

Geist Season of Code

HeKatE

Public

Różnice