Podstawy programowania (I) - Laboratorium

Podstawowe informacje - organizacja

• Wysyłane wiadomości e-mail proszę tytułować oraz dodawać przedrostek [PRI]. Brak takiego przedrostka może spowodować znaczące wydłużenie czasu odpowiedzi na wiadomość.
• W załącznikach mailowych z kodem proszę nie umieszczać plików wynikowych (tj. bez *.exe, *.o, itp). Takie maile często są przez klientów poczty odrzucane, przez co może wydłużyć się czas odpowiedzi na takie wiadomości. Lub może do odpowiedzi nie dojść.
• Najlepiej, aby załącznik był jednym plikiem (tj. archiwum) o łatwo identyfikowalnej nazwie, np.: PRI-AKowalski-Proj2.zip
• Ocenianie projektu odbywa się w obecności autora, na komputerze dostępnym w sali laboratoryjnej (nie na własnym laptopie).
• Podczas oceniania projektu prowadzący prosi o wyjaśnienie fragmentów kodu. Jest to część również poddawana ocenie.
• W razie wątpliwości, uwag czy niejasności proszę pytać prowadzącego. Najlepiej przed terminem oddania projektu.
• W dokumentacjach proszę o podanie informacji organizacyjnych (autor, adres mail, temat projektu, semestr, itp.).
• W dokumentacji mile widziana jest konstruktywna krytyka. Co było ciekawe albo trudne. Co można zrobić inaczej następnym razem przy podobnym problemie.
• W terminach oddawania projektu nie ma możliwości dłuższej dyskusji. Prawie całe zajęcia wtedy służą ocenie projektów.

Podstawowe informacje - implementacja

• Program powinien być napisany w języku C, nie C++.
• Zachowujemy spójność języka (tzn. jeśli korzystamy z języka polskiego, to korzystajmy z niego konsekwentnie).
• Zamiast wprowadzać dodatkowe funkcjonalności lepiej zadbać o jakość podstawowej.
• Kod powinien być uporządkowany, czytelny oraz sformatowany. Chociażby wcięcia.
• Kod powinien posiadać komentarze do kluczowych i/lub skompilkowanych fragmentów.
• Program powinien być sensownie podzielony na pliki.
• Program powinien być napisany w sposób modułowy.
• Program nie powinien zwykle korzystać ze zmiennych globalnych.
• Preprocesora używamy tylko do: warunkowej kompilacji oraz dołączania plików nagłówkowych.
• Kod powinen być możliwie nieskomplikowany.
• Zazwyczaj konieczne jest przygotowanie zestawu testów prezentujących działanie programu.
• Powinna zostać zaimplementowana przynajmniej podstawowa kontrola błędów.
• Jeśli zadanie nie określa inaczej, należy korzystać ze standardowych bibliotek, a nie implementować własne rozwiązania.
• Program kompilujący się nie oznacza, że dobrze działa.
• Program działający dla jednego przypadku nie oznacza, że działa dla wielu.
• Program działający dla wielu przypadków nie oznacza, że działa dla każdego.
• Dobrze jest najpierw myśleć, później pisać.
• Bardzo pomocna jest większość 'Golden rules of programming' czy też 'Zen of programming'.
• Unikamy dynamicznej alokacji pamięci, gdy nie jest to konieczne.
• W kodzie programu nie używamy 'magicznych' stałych.