I den här handledningen lär vi oss att skapa kommentarer i Python med hjälp av exempel.
Video: Kommentarer i Python
Kommentarer är beskrivningar som hjälper programmerare att bättre förstå programmets avsikt och funktionalitet.
De ignoreras helt av Python-tolk.
Fördelar med att använda kommentarer
Att använda kommentarer i program gör vår kod mer begriplig. Det gör programmet mer läsbart vilket hjälper oss att komma ihåg varför vissa kodblock skrevs.
Annat än så kan kommentarer också användas för att ignorera viss kod medan andra kodblock testas. Detta erbjuder ett enkelt sätt att förhindra exekvering av vissa rader eller skriva en snabb pseudokod för programmet.
Enradiga kommentarer i Python
I Python använder vi hash-symbolen för #att skriva en enradig kommentar.
Exempel 1: Skriva enradiga kommentarer
# printing a string print('Hello world')
Produktion
Hej världen
Här är kommentaren:
# printing a string
Denna linje ignoreras av Python-tolk.
Allt som kommer efter #ignoreras. Så vi kan också skriva ovanstående program i en enda rad som:
print('Hello world') #printing a string
Resultatet för detta program kommer att vara detsamma som i exempel 1 . Tolken ignorerar all text efter #.
Flerlinjekommentarer i Python
Python erbjuder inte ett separat sätt att skriva flerlinjiga kommentarer. Det finns dock andra sätt att komma runt problemet.
Vi kan använda #i början av varje kommentarrad på flera rader.
Exempel 2: Använda flera #
# it is a # multiline # comment
Här behandlas varje rad som en enda kommentar och alla ignoreras.
Stränglitteratur för flerradiga kommentarer
Även om det inte finns något unikt sätt att skriva flerlinjiga kommentarer i Python vet vi att Python-tolk ignorerar stränglitteralerna som inte tilldelas en variabel.
Så vi kan till och med skriva en enradig kommentar som:
#this is a comment 'this is an unassigned string as a comment '
Här kan vi se att den andra raden i programmet är en sträng men inte tilldelas någon variabel eller funktion. Så tolken ignorerar strängen.
På ett liknande sätt kan vi använda flerlinjiga strängar (trippel citat) för att skriva flerlinjiga kommentarer.
Citattecknet kan antingen vara 'eller ".
Exempel 3: Använd stränglitteratur för att skriva kommentarer med flera rader
''' I am a multiline comment! ''' print("Hello World")
Här tilldelas inte flerlinjesträngen till någon variabel, så den ignoreras av tolken. Även om det tekniskt inte är en multilinjekommentar kan den användas som en.
Python docstrings
Enligt konvention är de tre citaten som visas direkt efter funktionen, metoden eller klassdefinitionen docstrings (dokumentationssträngar).
Docstrings är associerade med objekt och kan nås med __doc__attributet.
För att lära dig mer, besök Python docstrings.
Hur man skriver bättre kommentarer?
- Använd kommentarer för att beskriva vad en funktion gör och inte de specifika detaljerna för hur funktionen gör det.
- Försök att ta bort så många överflödiga kommentarer som möjligt. Försök skriva kod som kan förklara sig själv med bättre funktion / variabelnamn val.
- Försök att göra kommentarerna så korta och kortfattade som möjligt.
