- Pamięć człowieka jest bardzo ulotna.Uwierz mi, że w następnym semestrze, gdy będziesz chciał ponownie użyć stworzonego przez siebie skryptu, nie będziesz przekonany jak on tak naprawdę działa. Co więcej zaczniesz się też zastanawiać skąd wzięły się te wartości i dlaczego wynoszą właśnie tyle?
- Dlatego zachęcam, żebyś opisywał czego dotyczy wprowadzana wartość oraz skąd się ona bierze lub z jakiego punktu normy pochodzi. Może wydaje ci się to przesadą, ale te kilka sekund które poświęcisz teraz, zaoszczędzi Ci wiele minut albo nawet godzin w przyszłości.
- Inne osoby, które potencjalnie będą wykorzystywać twój kod, będą miały ułatwione zadanie. Po przeczytaniu komentarzy będą mogły zorientować się o co w tym wszystkim chodzi. Pamiętaj, żeby jednak nie przesadzać i nie komentować rzeczy oczywistych.
2. Stosuj określone wcięcia dla danego typu tekstu - wymyśl sobie szablon, który będziesz stosował do wszystkich projektów. Wykorzystuj dobrodziejstwa stylów i wyróżnij główne punkty swojej pracy. Pozwoli to na łatwiejsze odnalezienie w gąszczu wzorów oraz znaczną poprawę wizualnej strony projektu.
3. Stosuj znaczące nazwy zmiennych - dzięki temu, gdy pojawi się ona za kilkanaście stron nadal będziesz wiedział czego dotyczy. Nie będziesz musiał wracać do początku lub szukać jej po całym dokumencie.
4. Pisz skrypty rozwiązujące konkretne zadania - staraj się pisać skrypty w taki sposób, aby stanowiły one swego rodzaju klocki z których można złożyć kolejne zabawki. Dla przykładu możesz stworzyć algorytmy do określania otuliny betonu, skrypt do określania parametrów betonu na podstawie jego klasy, czy też parametrów danego typu dwuteownika. Może ten jeden raz zajmie ci to wszystko nieco więcej czasu, ale następny projekt będziesz składał jak klocki lego - nie muszę chyba dodawać ile czasu zaoszczędzisz?
4. Pisz skrypty rozwiązujące konkretne zadania - staraj się pisać skrypty w taki sposób, aby stanowiły one swego rodzaju klocki z których można złożyć kolejne zabawki. Dla przykładu możesz stworzyć algorytmy do określania otuliny betonu, skrypt do określania parametrów betonu na podstawie jego klasy, czy też parametrów danego typu dwuteownika. Może ten jeden raz zajmie ci to wszystko nieco więcej czasu, ale następny projekt będziesz składał jak klocki lego - nie muszę chyba dodawać ile czasu zaoszczędzisz?
5. Stosuj się zasadę czarnej skrzynki (hermetyzacja) - gdy już napiszesz jakiś algorytm i jesteś pewny jego działania, warto ukryć jego "jądro". Użytkownik nie musi wiedzieć jak działa taki skrypt. Wystarczy, że określi dane wejściowe i otrzyma poprawne dane wyjściowe. Oczywiście zawsze istnieje furtka, żeby zobaczyć jak dany algorytm działa, ale jeżeli masz go sprawdzonego, to najczęściej nie ma potrzeby ponownie do niego zaglądać.
Na dzisiaj tylko pięć podstawowych zasad. Oczywiście może być ich dużo więcej i każdy z użytkowników może wypracować sobie własne. Dodatkowo warto czasem sięgnąć do pokrewnej dziedziny jaką jest programowanie, bo wiele można tam podpatrzeć i wdrożyć z powodzeniem w swojej pracy.
0 komentarze:
Prześlij komentarz