Witaj! Piszesz pracę inżynierską i musisz wkleić kod? Super! Zaraz zobaczysz, że to nic trudnego.
Krok 1: Skąd wziąć kod?
Masz swój własny kod? Świetnie! Zapisany jest w pliku tekstowym, na przykład w pliku z rozszerzeniem .py (dla Pythona) lub .java (dla Javy)? Otwórz ten plik w edytorze tekstu.
Używasz jakiejś biblioteki? A może znalazłeś fragment kodu w internecie, na przykład na Stack Overflow? Sprawdź, czy możesz go legalnie użyć w swojej pracy. Zwykle trzeba podać źródło.
Kiedy już znajdziesz potrzebny kod, zaznacz go. Użyj myszki lub klawiatury, aby go zaznaczyć.
Krok 2: Kopiowanie kodu
Zaznaczyłeś kod? Super! Teraz musisz go skopiować. Możesz to zrobić na kilka sposobów. Najprostszy to użyć skrótu klawiszowego: Ctrl+C (na Windowsie) lub Cmd+C (na Macu). Pamiętaj, żeby nacisnąć Ctrl i C jednocześnie.
Możesz też kliknąć prawym przyciskiem myszy na zaznaczonym kodzie. Pojawi się menu. Wybierz opcję "Kopiuj" albo "Copy".
Trzecia opcja to użycie menu edytora tekstu. Poszukaj opcji "Edycja" albo "Edit". W menu znajdziesz opcję "Kopiuj" albo "Copy".
Krok 3: Wklejanie kodu
Skopiowałeś kod? Świetnie! Teraz musisz go wkleić do swojej pracy inżynierskiej. Otwórz dokument, w którym piszesz pracę. To może być Microsoft Word, LibreOffice Writer, albo jakiś edytor LaTeX.
Znajdź miejsce, w którym chcesz wkleić kod. Kliknij tam myszką. Teraz możesz wkleić kod. Podobnie jak przy kopiowaniu, masz kilka opcji.
Użyj skrótu klawiszowego: Ctrl+V (na Windowsie) lub Cmd+V (na Macu). Pamiętaj, żeby nacisnąć Ctrl i V jednocześnie.
Kliknij prawym przyciskiem myszy w miejscu, gdzie chcesz wkleić kod. Pojawi się menu. Wybierz opcję "Wklej" albo "Paste".
Użyj menu edytora tekstu. Poszukaj opcji "Edycja" albo "Edit". W menu znajdziesz opcję "Wklej" albo "Paste".
Krok 4: Formatowanie kodu
Wkleiłeś kod? Super! Ale prawdopodobnie wygląda on trochę dziwnie. Trzeba go sformatować. Chodzi o to, żeby kod był czytelny i dobrze wyglądał w Twojej pracy.
Przede wszystkim, sprawdź wcięcia. Wcięcia to puste miejsca na początku linii kodu. W Pythonie wcięcia są bardzo ważne! Zaznacz cały kod i sprawdź, czy wcięcia są poprawne. Możesz użyć klawisza Tab, żeby wciąć kod. Użyj Shift+Tab, żeby cofnąć wcięcie.
Wiele edytorów tekstu ma funkcję automatycznego formatowania kodu. Poszukaj opcji "Formatuj kod" albo "Format Code". Możesz też zainstalować specjalne wtyczki do formatowania kodu.
Zwróć uwagę na czcionkę. Najlepiej użyć czcionki o stałej szerokości, na przykład Courier New albo Consolas. Dzięki temu wszystkie znaki będą miały taką samą szerokość, a kod będzie bardziej czytelny.
Możesz też użyć kolorowania składni. Kolorowanie składni to automatyczne kolorowanie słów kluczowych, komentarzy i innych elementów kodu. Dzięki temu kod jest jeszcze bardziej czytelny.
Krok 5: Wklejanie kodu jako obrazek (awaryjnie)
Czasami wklejanie kodu jako tekst może być problematyczne. Szczególnie, jeśli używasz skomplikowanego edytora tekstu albo LaTeX-a. Wtedy możesz wkleić kod jako obrazek.
Zrób zrzut ekranu (screenshot) z kodem. Na Windowsie możesz użyć klawisza Print Screen. Na Macu możesz użyć skrótu Cmd+Shift+4. Następnie wklej obrazek do dokumentu.
Pamiętaj, że wklejanie kodu jako obrazek ma swoje wady. Nie możesz skopiować kodu z obrazka. Obrazek może być niewyraźny. Dlatego lepiej używać tej metody tylko w ostateczności.
Krok 6: Oznaczanie kodu
Ważne jest, aby wyraźnie oznaczyć w pracy inżynierskiej, które fragmenty stanowią kod. Można to zrobić na kilka sposobów:
Blok kodu: Oddziel fragment kodu od reszty tekstu, umieszczając go w osobnym bloku, na przykład otocz go ramką.
Czcionka o stałej szerokości: Używaj czcionki o stałej szerokości (np. Courier New, Consolas) tylko dla fragmentów kodu. To od razu sygnalizuje, że to nie jest zwykły tekst.
Wcięcie: Zastosuj wcięcie dla całego bloku kodu, aby odróżnić go od reszty tekstu. To bardzo pomaga w czytelności.
Opis: Dodaj krótki opis przed blokiem kodu, wyjaśniający, co dany fragment kodu robi.
Krok 7: Komentowanie kodu
Jeśli używasz dłuższego fragmentu kodu, warto go skomentować. Komentarze to krótkie opisy w kodzie, które wyjaśniają, co robi dana linia albo blok kodu. Komentarze są ignorowane przez komputer, ale bardzo pomagają ludziom zrozumieć kod.
W Pythonie komentarze zaczynają się od znaku #. W Javie komentarze jednoliniowe zaczynają się od //, a komentarze wieloliniowe umieszcza się między /* i */.
Komentuj kod! Wyjaśnij, co robią poszczególne fragmenty. To ułatwi zrozumienie kodu Tobie i Twojemu promotorowi.
Krok 8: Cytowanie kodu
Pamiętaj o cytowaniu kodu, który nie jest Twojego autorstwa. Podaj źródło, skąd pochodzi kod. To bardzo ważne! Kopiowanie kodu bez podania źródła to plagiat.
Podaj autora kodu, tytuł strony, datę dostępu i adres URL. Możesz użyć przypisu dolnego albo bibliografii na końcu pracy.
Sprawdź zasady cytowania, które obowiązują na Twojej uczelni. Upewnij się, że cytujesz kod zgodnie z tymi zasadami.
Podsumowanie
Wklejanie kodu do pracy inżynierskiej to nie jest trudne! Pamiętaj o kopiowaniu, wklejaniu, formatowaniu, oznaczaniu, komentowaniu i cytowaniu kodu. Dzięki temu Twoja praca będzie czytelna, zrozumiała i profesjonalna.
Powodzenia z pisaniem pracy inżynierskiej!
