Kommentarer er en væsentlig del af ethvert programmeringssprog, inklusive Python. De hjælper dig og andre udviklere med at forstå logikken og funktionaliteten af din kode. Når du tilføjer kommentarer til din Python-kode, hjælper det dig ikke kun med at forklare din kode, men forbedrer også dens læsbarhed, kvalitet og vedligeholdelse.
I denne Python-tutorial vil vi undersøge, hvordan man skriver en enkelt linjekommentar, flerlinjekommentarer og flerlinjede strenge. Vi vil dykke ned i, hvordan du bruger kommentarer i dit Python-program, forstår forskellige typer af Python-kommentarer og forskellige anvendelsesmuligheder for hver kommentartype. Dette vil omfatte eksempler, der viser, hvordan man skriver gode kommentarer, tilføjer indlejrede kommentarer og undgår at skrive dårligt skrevet kode.
Lad os komme ind i det.
Indholdsfortegnelse
Hvad er single-line kommentarer?
I Python- programmering oprettes en enkelt linjekommentar ved hjælp af hash-tegnet (#) i begyndelsen af en linje. Enhver tekst, der følger hash-symbolet på samme linje, behandles som en enkelt linjekommentar, og Python-fortolkeren vil ikke udføre den.
Der er to primære formål med at bruge enkeltlinjekommentarer i Python-kode:
Giver en kort forklaring eller en oversigt over det specifikke Python-kodesegment, der giver indsigt i kodens funktion eller formål.
Midlertidig deaktivering af en enkelt linje kode fra at blive udført, hvilket er nyttigt under fejlfinding eller test, uden permanent at fjerne koden fra dit script.
Følgende er en kode på en enkelt linje:
I dette eksempel tilbyder hver enkelt linjekommentar forklaringer for hver kodelinje, hvilket gør det nemmere for dig og andre udviklere at forstå formålet med koden.
Python - koden nedenfor demonstrerer, hvordan man skriver kommentarer for at forhindre, at en enkelt linje kode bliver eksekveret:
I eksemplet ovenfor er konsoludskriftserklæringen med strenge bogstaver, beregnet til fejlfindingsformål, blevet kommenteret ud for at forhindre dens eksekvering, når koden køres. Enkeltlinjekommentaren sikrer, at tolken behandler linjen som en kommentar i stedet for et stykke kode.
Det kan være en fordel at kommentere specifikke linjer kode, når du fejlretter og løser fejl.
At overtage vanen med at skrive klare, præcise og relevante kommentarer på en enkelt linje er god praksis, da det hjælper med at fokusere på at forklare bestemte aspekter af din kode. Ved at lave velskrevne kommentarer forbedrer du markant læsbarheden og vedligeholdelsen af dine Python-programmer, hvilket gør det nemmere for andre at forstå og arbejde med din kode.
Hvad er kommentarer med flere linjer?
Python multiline-kommentarer er nyttige, når de giver mere omfattende forklaringer eller noter vedrørende specifikke kodesektioner. De er også nyttige, når du midlertidigt skal deaktivere flere linjer kode under fejlfinding eller udvikling uden at skulle kommentere hver linje individuelt.
Der er to metoder til at oprette kommentarer med flere linjer
Brug af Triple Quote
Brug af et Hash-symbol med fortsættelse
Brug af tredobbelte citater
En måde at oprette kommentarer med flere linjer på er ved at bruge tredobbelte anførselstegn, som består af tre på hinanden følgende enkelte eller dobbelte anførselstegn.
Når en tekstblok er omgivet af tredobbelte anførselstegn, fortolker Python den som en streng og ser bort fra den, hvis den ikke er tildelt en variabel.
Denne teknik giver dig mulighed for at skrive Python-kommentarer med flere linjer eller strenge med flere linjer, der spænder over flere linjer, hvilket forbedrer din kodes læsbarhed.
Følgende kode hjælper med at forklare brugen af tredobbelte anførselstegn for en multikode:
'''
This is a multi-line comment
in Python using triple quotes.
'''
print("Hello World!")
Ovenstående kode vil kun udsende "Hello World!" da den tredobbelte citerede flerlinjestreng ignoreres af tolken.
Brug af et Hash-symbol med linjefortsættelse
En anden tilgang til at oprette kommentarer med flere linjer i Python involverer at bruge hash-symboler (#) i begyndelsen af hver linje, sammen med linjefortsættelsestegn () for at bevare læsbarheden.
Det følgende er et eksempel på, hvordan man skriver kommentarer med flere linjer i Python:
# This is a multi-line comment in Python
# using hash symbols with line continuation.
# It spans multiple lines, but each line requires a hash symbol.
print("Hello World!")
I ovenstående eksempel, kun "Hello World!" vil også blive udlæst, da linjer, der starter med et hash-symbol, behandles som kommentar med flere linjer af tolken.
Hvad er inline-kommentarer?
Indlejrede kommentarer i Python giver dig mulighed for at give kontekst eller forklaringer til specifikke kodelinjer. Disse typer kommentarer placeres på samme linje som kodesætningen, adskilt af et hash-mærke (#).
Følgende er et eksempel på indlejret kommentar i Python:
x = 10 # This variable stores the value 10
y = x * 2 # Multiply x by 2 to get the value of y
print(y) # Output the value of y
Inline-kommentarer bør bruges sparsomt og kun når det er nødvendigt for at forklare en specifik kodelinje. Hvis din kode kræver omfattende indlejrede kommentarer, kan du overveje at gøre selve koden klarere og mere selvforklarende ved at bruge mere beskrivende variabel- eller funktionsnavne.
Hvad er Docstrings?
Docstrings fungerer som et værdifuldt værktøj til at dokumentere din kode effektivt. De hjælper både dig og andre udviklere med at forstå, hvordan din kode fungerer og dens tilsigtede formål.
Ved at inkorporere docstrings i dine Python-programmer kan du skabe klare, kortfattede og nyttige forklaringer, der i høj grad forbedrer læsbarheden og vedligeholdelsen af din kode.
Denne praksis fremmer bedre samarbejde og kommunikation mellem udviklere, hvilket i sidste ende forbedrer kvaliteten af den software, du opretter.
Der er tre typer docstrings i Python, alle med den samme syntaks, men forskellige anvendelsestilfælde:
Funktion og metode Docstrings
Klasse Docstrings
Klasse Docstrings
Funktion og metode Docstrings
Funktions- og metode-docstrings beskriver formålet, argumenter, returværdier og bivirkninger af en funktion eller metode.
Følgende er et eksempel på funktion og metode docstrings:
def add(a, b):
"""Add two numbers and return the result."""
return a + b
Denne docstring skal altid give en kortfattet, men informativ beskrivelse af funktionen.
Klasse Docstrings
Klasse docstrings forklarer formålet og adfærden for en klasse i Python.
Det følgende er et eksempel på brug af klasse docstrings til at forklare formålet med og adfærden for en klasse i Python.
class MyClass:
"""A simple class to demonstrate docstrings."""
def __init__(self, x):
self.x = x
Docstringen skal give et overblik over klassens funktionalitet, eventuelle vigtige attributter eller egenskaber, den måtte have, og hvordan den interagerer med andre klasser eller funktioner i dit program.
Modul Docstrings
Modul docstrings bør placeres i begyndelsen af dine Python-moduler eller modulfiler, hvilket giver et omfattende overblik over modulets formål og dets indhold.
Ved at inkludere en velskrevet modul docstring, giver du udviklere mulighed for hurtigt at konstatere, hvordan dit modul passer ind i den overordnede arkitektur af dit projekt og de specifikke funktionaliteter, det leverer.
Denne praksis forbedrer ikke kun læsbarheden og vedligeholdelsen af din kode, men fremmer også forbedret samarbejde og forståelse blandt teammedlemmer, der arbejder på det samme projekt.
Følgende er et eksempel på brug af modul docstrings til at knytte dokumentation til Python-filer:
"""
geometry.py
This module contains functions to calculate the area of various geometric shapes,
such as rectangles, circles, and triangles. The main functions provided are:
- rectangle_area(width, height)
- circle_area(radius)
- triangle_area(base, height)
Each function takes the respective dimensions as input and returns the calculated area.
"""
def rectangle_area(width, height):
return width * height
def circle_area(radius):
import math
return math.pi * (radius ** 2)
def triangle_area(base, height):
return 0.5 * base * height
# Rest of the code...Modulets primære funktioner og eventuelle vigtige variabler, klasser eller funktioner, det inkluderer.
Bedste praksis for at skrive kommentarer
Ok, så nu har du en god idé om de forskellige typer kommentarer i Python, og hvordan du bruger dem, lad os se på nogle bedste praksisser for at holde en høj standard på arbejdet.
Klarhed og kortfattethed
Når du skriver kommentarer i Python, er det vigtigt at finde en balance mellem klarhed og kortfattethed. Sigt efter at udtrykke dine tanker på en måde, der letter forståelsen, samtidig med at du sikrer, at kommentarerne forbliver korte og informative.
Afstå fra at inkludere unødvendige oplysninger for at forhindre, at kommentarer bliver alt for langvarige og udfordrende at vedligeholde, hvilket i sidste ende kan føre til forvirring.
En gennemarbejdet kommentar bør ubesværet integreres med din kode, hvilket øger læsbarheden og vedligeholdelsesvenligheden.
Undgå åbenlyse kommentarer
Det er vigtigt at undgå indlysende beskrivelser, hvornår . I stedet for blot at gentage eller duplikere, hvad koden gør, skal du koncentrere dig om at tilbyde indsigt, som måske ikke umiddelbart fremgår af selve koden.
Dette gælder for at skrive en enkelt linjekommentar og også for flerlinjekommentarer.
For at illustrere dette, overvej følgende eksempel, som kontrasterer en åbenlys kommentar med et mere nyttigt alternativ:
# Bad comment
x = x + 1 # Increment x by 1
# Good comment
x = x + 1 # Adjust x to account for the new user addedOpdatering af kommentarer som kodeændringer
Efterhånden som koden udvikler sig, skal du vedligeholde opdaterede Python-kommentarer. Forældede kommentarer kan vildlede og forårsage forvirring. Når du laver væsentlige ændringer i din kode, skal du justere Python-kommentarerne i overensstemmelse hermed for at bevare læsbarheden og forståelsen.
Ønsker du at uddybe din Python-viden, kan du se vores omfattende Python-videoer nedenfor.
Konklusion
At kommentere din kode giver flere fordele, såsom at hjælpe med forståelse, vedligeholdelse og tjene som værdifuld dokumentation for samarbejdspartnere.
For at sikre effektiv kommentering:
Hold kommentarer kortfattede, relevante og informative.
Brug et hash-symbol (#) efterfulgt af et mellemrum til kommentarer på en enkelt linje.
Brug anførselstegn (""""") til at skrive kommentarer med flere linjer
Brug inline og bloker kommentarer til kontekst eller forklaringer.
Opdater kommentarer, efterhånden som koden udvikler sig for at bevare læsbarheden.
Øv dig i at skrive tankevækkende kommentarer for at forbedre programmeringsevnerne.
Ved konsekvent at bruge gennemarbejdede kommentarer hjælper du ikke kun dig selv og andre, men løfter også din programmeringsekspertise.
Ved også at være opmærksom på kommentarkvalitet og inkorporere værdifuld indsigt i dine kommentarer, bliver du en mere effektiv, organiseret og professionel koder, hvilket gør det nemmere at samarbejde med andre og vedligeholde din kode i det lange løb.
Denne blog indeholder LuckyTemplates TOPN DAX-funktionen, som giver dig mulighed for at få unik indsigt fra dine data, hvilket hjælper dig med at træffe bedre markedsføringsbeslutninger.
Find ud af, hvorfor det er vigtigt at have en dedikeret datotabel i LuckyTemplates, og lær den hurtigste og mest effektive måde at gøre det på.
Denne korte vejledning fremhæver LuckyTemplates mobilrapporteringsfunktion. Jeg vil vise dig, hvordan du kan udvikle rapporter effektivt til mobilenheder.
I denne LuckyTemplates Showcase gennemgår vi rapporter, der viser professionel serviceanalyse fra et firma, der har flere kontrakter og kundeengagementer.
Gå gennem de vigtigste opdateringer til Power Apps og Power Automate og deres fordele og implikationer for Microsoft Power Platform.
Opdag nogle almindelige SQL-funktioner, som vi kan bruge, såsom streng, dato og nogle avancerede funktioner til at behandle eller manipulere data.
I denne tutorial lærer du, hvordan du opretter din perfekte LuckyTemplates-skabelon, der er konfigureret til dine behov og præferencer.
I denne blog vil vi demonstrere, hvordan man lagdelte feltparametre med små multipler for at skabe utrolig nyttig indsigt og visuals.
I denne blog vil du lære, hvordan du bruger LuckyTemplates rangerings- og brugerdefinerede grupperingsfunktioner til at segmentere et eksempeldata og rangordne det efter kriterier.
I denne tutorial vil jeg dække en specifik teknik omkring, hvordan du kun viser Kumulativ Total op til en bestemt dato i dine visuals i LuckyTemplates.
