Koncepcje programowania/Komentarze

Z Wikibooks, biblioteki wolnych podręczników.
Przejdź do nawigacji Przejdź do wyszukiwania

Czym są komentarze? To specjalnie sformatowany fragment kodu źródłowego, za pomocą którego opisujemy poszczególne części programu, bo zazwyczaj kody źródłowe naszych programów będą rozbudowane i pozwalają nam zrozmieć, która część kodu za co odpowiada. Bo np. za rok możemy nie pamiętać w jaki sposób napisali program, inni programiści czytający nasz kod także może mieć problem z początkowym zrozumieniem go.

Czyli w komentarzach wpisujemy treść, zrozumiałą dla człowieka, opisujemy do czego służą poszczególne fragmenty kodu źródłowego i te komentarza są po prostu ignorowane przez komputer.

Komentarze w Pythonie mamy liniowe, czyli obejmujący jedną linię, jeden wiersz. Skutkuje to zignorowaniem całej pojedynczej linijki kodu. Stawiając znak "hasha" (#), zaraz po nim możemy pisać co chcemy i jak chcemy.

# To jest treść komentarza

Przykład w języku JavaScript:

// To jest treść komentarza

Można też wstawiać komentarze śródliniowy, czyli taki komentarz, który pojawia się w tej samej linii co wykonywalny kod programu:

print("Hello World") # To jest treść komentarza

lub

alert("Hello World") // To jest treść komentarza

Trzecim rodzajem komentarzy jest komentarz blokowy, nazywany także jako wielowierszowy czy też wielolinijkowy. Pozwala on na pisanie dowolnych znaków w obrębie WIELU linijek i to jest cała różnica pomiędzy jednym, a drugim. Formułuje się nieco trudniej. W jednej linijce wstawiamy /*, a następnie tam gdzie ma się on kończyć, stawiamy */

Przykład w języku JavaSript:

/*
to
jest
komentarz
blokowy
*/

W języku Python, nie ma formalnego sposobu na wstawianie komentarzy blokowych. Pewną niepisaną zasadą programistów w jego przypadku, jest używanie do tego celu łancuchów, znanych z poprzedniego rozdziału, czyli trzech apostrofów:

'''
to
jest
komentarz
blokowy
'''

Aczkolwiek jeśli chcemy to robić jak najbardziej poprawnie, warto zaopatrzyć się w edytor tekstu kodu źródłowego, który ułatwi nam pracę i będzie wstawiał samodzielnie znak # w momencie gdy będziemy tworzyć komentarze blokowe.