Doszlifowanie projektu, testowanie, dokumentacja
ð Podstawa programowa: IV.1+II.2To ostatnia lekcja na prace nad kodem. Nastepna lekcja to prezentacje! Dzis skupiamy sie na: dopracowaniu detali, testowaniu i dokumentacji.
# PRZED - brudny kod:
def f(x):
y=[]
for i in range(len(x)):
if x[i]%2==0:
y.append(x[i])
return y
# PO - czysty kod:
def filtruj_parzyste(liczby):
"""Zwraca liste zawierajaca tylko parzyste liczby."""
parzyste = []
for liczba in liczby:
if liczba % 2 == 0:
parzyste.append(liczba)
return parzyste
"""
========================================
[TYTUL PROJEKTU]
========================================
Autor: [Imie i Nazwisko]
Klasa: III [litera]
Data: [data]
Jezyk: Python 3.x
OPIS:
[2-3 zdania opisujace, co robi program]
WYMAGANIA:
- Python 3.8 lub nowszy
- [wymagane biblioteki]
URUCHOMIENIE:
python nazwa_programu.py
INSTRUKCJA UZYTKOWANIA:
1. [krok 1]
2. [krok 2]
3. [krok 3]
STRUKTURA PROJEKTU:
- nazwa_programu.py - glowny plik programu
- dane.json - plik z danymi
- wyniki.txt - plik z wynikami
- README.txt - dokumentacja
LISTA FUNKCJI:
- main() - glowna funkcja programu
- wczytaj_dane() - wczytuje dane z pliku
- przetworz() - przetwarza dane
- zapisz_wyniki() - zapisuje wyniki do pliku
ZNANE OGRANICZENIA:
- [ograniczenie 1]
- [ograniczenie 2]
MOZLIWE ROZWINIECIA:
- [pomysl na rozszerzenie 1]
- [pomysl na rozszerzenie 2]
========================================
"""
Na nastepnej lekcji bedziesz prezentowal projekt. Przygotuj:
Przejrzyj caly kod projektu. Popraw: nazwy zmiennych na opisowe, dodaj komentarze i docstringi, usun zbedny kod, popraw formatowanie (wciecia, spacje). Usun tymczasowe print() do debugowania.
Przetestuj program wedlug checklisty: a) poprawne dane wejsciowe, b) bledne dane (puste, za dlugie, zle typy), c) wartosci brzegowe, d) szybkie wielokrotne uruchomienie. Napraw wszystkie znalezione bledy.
Napisz pelna dokumentacje projektu wedlug szablonu: opis, wymagania, instrukcja uruchomienia, lista funkcji, znane ograniczenia, mozliwosci rozwoju. Zapisz jako osobny plik README.txt.
Przygotuj prezentacje (6-8 slajdow) o swoim projekcie. Zawrzyj: demo/zrzuty ekranu, ciekawy fragment kodu, wyzwania, wnioski. Przetrenuj prezentacje - powinna trwac 5-8 minut.