Różnice

Różnice między wybraną wersją a wersją aktualną.

Odnośnik do tego porównania

Both sides previous revision Poprzednia wersja
Nowa wersja
Poprzednia wersja
pl:miw:miw08_hqedaudit [2008/06/02 00:32]
lrachwalski
pl:miw:miw08_hqedaudit [2019/06/27 15:50] (aktualna)
Linia 1: Linia 1:
 ====== HQedAudit ====== ====== HQedAudit ======
 +__**Projekt zakończony**__
 +
 Łukasz Rachwalski, <​LukaszRachwalski@gmail.com>​ Łukasz Rachwalski, <​LukaszRachwalski@gmail.com>​
 **Audyt kodu**, dokumentacja,​ uzupełenie komentarzy w kodzie w języku angielskim, testowanie. Wymagana [[pl:​miw:​miw08_hqedaudit]]. **Audyt kodu**, dokumentacja,​ uzupełenie komentarzy w kodzie w języku angielskim, testowanie. Wymagana [[pl:​miw:​miw08_hqedaudit]].
  
 ====== Spotkania ====== ====== Spotkania ======
- +[[https://​ai.ia.agh.edu.pl/​wiki/​pl:​miw:​miw08_hqedaudit:spotkania|Konsultacje]]
-===== 08.02.26 ===== +
-  * 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 ====== ====== Projekt ======
Linia 67: Linia 14:
   - Uzupełnić dokumentację w kodzie HQed i w wiki.   - Uzupełnić dokumentację w kodzie HQed i w wiki.
   - Przeprowadzić serię testów aplikacji.   - Przeprowadzić serię testów aplikacji.
- 
- 
  
 ===== Co się udało osiągnąć?​ ===== ===== Co się udało osiągnąć?​ =====
Linia 82: Linia 27:
     * 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.     * 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.     * Postawić kompletne środowisko uruchomieniowe.
- 
- 
  
  
 ====== Kompletne środowisko uruchomieniowe ====== ====== Kompletne środowisko uruchomieniowe ======
- 
- 
  
 ===== W skład kompletnego środowiska uruchomieniowego wychodzą: ===== ===== W skład kompletnego środowiska uruchomieniowego wychodzą: =====
Linia 100: Linia 41:
  
 ===== Konfiguracja poszczególnych komponentów ===== ===== Konfiguracja poszczególnych komponentów =====
- 
  
 ==== Ubuntu ver. 7.10 ==== ==== Ubuntu ver. 7.10 ====
Linia 125: Linia 65:
  
 Źródło powyższych informacji to: [[http://​www.clivecooper.co.uk/​tutorial/​index.html]]. Źródło powyższych informacji to: [[http://​www.clivecooper.co.uk/​tutorial/​index.html]].
- 
  
 ==== DoxyGen 1.5.3 ==== ==== 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. 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 ==== ==== Mantis Bug Trucker 1.1.1 ====
 Mantis Bug Trucker to darmowy system raportowania błędów powstałych podczas procesu tworzenia oprogramowania. Można go pobrać ze strony producenta Mantis Bug Trucker to darmowy system raportowania błędów powstałych podczas procesu tworzenia oprogramowania. Można go pobrać ze strony producenta
 [[http://​www.mantisbt.org/​]]. Został napisany w języku PHP i współpracuje z MySQL. Dzięki temu można go używać na wielu platformach m.in. Linux, Windows, Mac OS, OS/2. [[http://​www.mantisbt.org/​]]. Został napisany w języku PHP i współpracuje z MySQL. Dzięki temu można go używać na wielu platformach m.in. Linux, Windows, Mac OS, OS/2.
- 
- 
  
  
 ====== Komentowanie źródeł projektu ====== ====== Komentowanie źródeł projektu ======
  
- +===== Struktura katalogowa projektu ​=====
- +
- +
- +
-==== 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. 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.
  
Linia 159: Linia 91:
  
  
- +===== 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.     * Styl komentowania w [[http://​www.stack.nl/​~dimitri/​doxygen/​docblocks.html|DoxyGen]]:​ JavaDoc.
     * Komentowane są tylko pliki nagłówkowe.     * Komentowane są tylko pliki nagłówkowe.
     * Język komentarzy to angielski.     * Język komentarzy to angielski.
  
- +===== Skomentowane moduły ​=====
- +
-==== Skomentowane moduły ====+
     * Kompletna dokumentacja projektu HQed znajduje się [[https://​hekate.ia.agh.edu.pl/​webdoxy/​hqed/​doc/​|tutaj]].     * Kompletna dokumentacja projektu HQed znajduje się [[https://​hekate.ia.agh.edu.pl/​webdoxy/​hqed/​doc/​|tutaj]].
  
 +===== Podsumowanie =====
 +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.
  
  
Linia 175: Linia 106:
  
 Testy przeprowadzono na przykładach zaczerpniętych z [[pl:​miw:​miw08_xtt_serialization]]. Testy przeprowadzono na przykładach zaczerpniętych z [[pl:​miw:​miw08_xtt_serialization]].
- 
  
 ===== Test Funkcjonalności Aplikacji HQed ===== ===== Test Funkcjonalności Aplikacji HQed =====
  
 Testy funkcjonalności znajdują się {{:​pl:​miw:​protokul_testu_hqed.pdf|tutaj}}. Testy funkcjonalności znajdują się {{:​pl:​miw:​protokul_testu_hqed.pdf|tutaj}}.
- 
- 
  
 ===== Test 1 - Cennik biletów na wyciąg narciarski ===== ===== Test 1 - Cennik biletów na wyciąg narciarski =====
Linia 188: Linia 116:
   - Uwagi:   - Uwagi:
   * program czasem błędnie interpretuje typ enumerate   * 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 ===== ===== Test 2 - Ceny biletów na pociąg =====
Linia 196: Linia 124:
   * program czasem błędnie intrpretuje wprowadzony typ enumerate   * 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 ====== ====== Podsumowujące sprawozdanie z projektu ======
Linia 219: 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. 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]]. 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]].
  
pl/miw/miw08_hqedaudit.1212359538.txt.gz · ostatnio zmienione: 2019/06/27 15:58 (edycja zewnętrzna)
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0