At skrive gode kommentarer i Python vil give andre udviklere og testere mulighed for nemt at læse og forstå din kode.
Ren kode med ensartet syntaks, beskrivende variabelnavngivning og indrykning er som den første bog, nemmere at forstå og vedligeholde.
Plus, i disse dage er det mindre almindeligt for en person at skrive den komplette kode for hele applikationen eller softwaren; snarere vil et team eller en gruppe mennesker arbejde hen imod det samme mål. I dette tilfælde gør ren og læsbar kode samarbejdet enklere og mere effektivt.
Udviklere og testere sigter altid efter at implementere fejlfri software til produktion. At skrive ren og læsbar kode fremskynder denne proces ved at gøre fejlfinding enklere og mere præcis. Selvom du finder nogle fejl i produktionen, er renere kode nemmere at opdatere.
Endnu vigtigere, ren og læsbar kode lever længere, fordi koden forbliver frisk som tiden går.
Endelig er det afgørende at have ren og læsbar kode for at skabe langtidsholdbar software. Men spørgsmålet er, hvordan vi helt præcist opnår det? Nå, en metode er at bruge kommentarer.
Er det ikke frustrerende, når du har skrevet hele koden til en kompleks logik, men dagen efter, når du ikke kan fortsætte, hvor du slap? Dette sker ikke, når du skriver kommentarer.
Kommentarer er et menneskeligt sprog, der forklarer, hvad kildekoden gør. Du kan skrive dem på ethvert sprog, helst engelsk, da det er et globalt sprog.
Så hver gang du kommer tilbage til din kildekode efter dage eller endda år, vil kommentarerne forklare dig, hvad du engang skrev.
De hjælper også andre udviklere med nemt at forstå din kode. Det er derfor, koden skrevet med kommentarer forbliver for evigt, selv i fravær af forfatteren.
Desuden er det ret almindeligt at have konflikter, når man beskæftiger sig med forskellige programmeringssprog, især når man arbejder i et team. Det er her kommentarer kommer til undsætning. Selvom du ikke kender programmeringssproget for kildekoden skrevet af din holdkammerat, hjælper kommentarer dig med at forstå logikken bag det.
Kodedokumentation er en mere omfattende måde at vedligeholde din kildekode på og lader dit team samarbejde problemfrit. Den indeholder alt om koden, såsom design, funktionalitet, arkitektur, komponenter osv.,
Kommentarer bidrager endda til denne kodedokumentation. Velskrevne kommentarer kan tages direkte ind i kodedokumentationen, så udviklere ikke kun får hvad og hvorfor, men også hvordan din kode.
- Kommentarer læser ikke bare koden op, men hjælper dig også med at forstå udviklerens hensigt bag hver linje. Så hvis du finder en fejl i fremtiden, vil du vide, hvor du nøjagtigt skal foretage kodeopdateringerne.
- Du kan skrive kommentarer som et afsnit for hele koden eller individuelle linjer, der forklarer, hvad hver kodeblok gør. På denne måde lader de dig og andre udviklere forstå koden godt, hvilket forbedrer læsbarheden.
- Kommentarer kan opdele koden i logiske sektioner, hvilket gør kodenavigation lettere.
- Du bør inkludere kommentarer, der beskriver forventede input, output og use cases, så en tester kan læse din kode.
- Endelig forbedrer du den overordnede læsbarhed af kodedokumentationen, hvis du sætter velskrevne kommentarer i din dokumentation.
Kommentarer i Python begynder med et hash-symbol (#). Så når du starter en linje med hash (#), så behandles alt skrevet i den linje som en kommentar.
Når du kører koden, ignorerer compileren linjen, der starter med hash (#), som om den ikke engang eksisterer. Kommentarerne forbliver dog synlige i kildekoden for at tjene deres formål.
Der er tre hovedtyper.
Det er dem, du har set ovenfor. De starter med hash-symbolet (#). Grundlæggende er linjen, der starter med hash-symbolet (#) dedikeret til kommentaren. Så dette kaldes en enkeltlinjekommentar, hvor du kun kan skrive en kommentar på én linje, der starter med hash (#).
Sådan kan du skrive kommentarer på én linje
# This is single line comment.
Teknisk set understøtter Python ikke kommentarer med flere linier, men der er måder at opnå dette på i Python.
Du kan også bruge hash (#) til at skrive kommentarer med flere linjer. Hver linje, du skriver, skal starte med et hash-symbol (#) her.
# This is the first comment. # This is second comment. # This is the last comment.
Indholdsfortegnelse
#3. Python Docstrings
En populær måde at skrive kommentarer på flere linjer er at bruge strenge bogstaver – “””….”””. Når du skriver noget mellem tredobbelte anførselstegn, ignorerer Python-kompileren disse linjer og udfører den resterende del i filen.
Disse kommentarer kaldes docstrings, når de er skrevet lige efter funktionerne, modulerne og klasserne.
Her er syntaksen til at gøre dette
""" Multi-line comments using docstrings in Python. """
At skrive klare og detaljerede kommentarer forbedrer din kodelæsbarhed og vedligeholdelse. Så her er de bedste praksisser for tydelige kommentarer i Python.
Kommentarer skal ikke kun fortælle, hvad koden gør, i stedet skal de afspejle formålet og hensigten bag hver linje.
Fjern forældede kommentarer, og sørg for at opdatere kommentarer, hver gang du ændrer koden.
I stedet for lange historier, skriv korte og direkte kommentarer.
Bad example: The function takes a,b as input, calculates a + b, and returns the value. Good example: The function returns the sum of a and b.
Brug af meningsfulde og beskrivende navne til variabler og funktionsnavne kan eliminere overflødige kommentarer.
Kode først? Eller kommentere først? At kommentere før kodning er den bedste praksis; det vil sige, skriv dine kommentarer og derefter den tilsvarende kode. På denne måde kan du først tænke på logikken og derefter konvertere den til kode.
# Returns true if the cnt is less than 1. return cnt < 1
Brug et konsekvent kommentarformat som mellemrum, indrykning, type kommentarer osv. for hele koden. Dette vil være mindre forvirrende og mere organiseret for læserne.
Brug docstrings til at forklare funktioner og klasser i Python som vist i følgende eksempel.
def add_num(a,b):
""" this function returns the sum of a and b """
sum = a+b
return sum
Undgå unødvendige kommentarer i din kode. For eksempel behøver den følgende kodelinje ikke en kommentar for at forstå den.
ans = 42
#1. Visual Studio Code Editor
Visual Studio Code Editor er den bedste IDE bygget af Microsoft til et komplet udviklingsmiljø. Med indbygget understøttelse af Node.js og JavaScript understøtter værktøjet også mange andre programmeringssprog problemfrit.
Dette meget tilpasselige værktøj har forskellige udvidelser til forskellige funktionaliteter. ‘Bedre kommentarer’ er en sådan udvidelse, der lader dig oprette menneskevenlige kommentarer.
Du kan kategorisere dine kommentarer i advarsler, forespørgsler, højdepunkter osv. for nemmere navigation.
VS-kode understøtter redigering af flere markører, så du kan kommentere eller redigere flere linjer samtidigt.
Denne editor er tilgængelig på alle større platforme som Mac, Windows og Linux.
#2. Sublim tekst
Sublim tekst er go-to editor for store projekter og tung kodning. Editoren er kendt for sin hastighed, tilpasning og genveje.
Værktøjets kraftfulde syntaksfremhævningsfunktion hjælper dig med nemt at skelne mellem koden og kommentarer.
Ligesom VS-kode understøtter Sublime-tekst også redigering af flere markører til at kommentere flere linjer på samme tid.
Takket være dens autofuldførelsesfunktion. Du behøver ikke manuelt at gentage kodelinjerne; denne funktion udfylder automatisk din kode baseret på mønstrene, hvilket hjælper dig med at kode hurtigere.
Desuden lader værktøjets ‘Goto Anything’-funktion dig skifte mellem funktionerne og filerne i dit projekt problemfrit.
#3. Notesblok++
Nodepad++ er en populær og enkel teksteditor skrevet i C++ og understøtter adskillige programmeringssprog. Det ligner ikke en moderne editor som VS Code eller Sublime Text; dens grænseflade er meget almindelig og ser ud som om den gør, hvad den skal.
Nodepad++ tilbyder adskillige standardgenveje til effektiv kommentering. Du kan også tilpasse genvejstastaturet for at tilpasse din kommentaroplevelse.
Dens dokumentkortfunktion viser dig overblikket over projektstrukturen, så du kan navigere problemfrit gennem filerne, mapperne og koden.
#4. Vim
Vim IDE giver hurtigere udvikling og kodeudførelse. Alt og hvad som helst kan gøres på denne editor ved hjælp af tastaturgenveje, så du bør lægge en seriøs indsats i at mestre det.
Denne tastaturcentrerede editor tilbyder også mange kommentarfunktioner via tastaturgenveje. Den har kraftfulde funktioner og kommandoer til effektivt at navigere hen over kommentarer.
Denne lette software kan håndtere enorme filer og hundredvis af programmeringssprog. Hvem hader gratis ting? Som alle redaktørerne på listen er Vim også helt gratis og open source.
Det kommer indbygget i macOS og Linux-systemer og kan downloades på Windows.
#5. PyCharm
PyCharm er en kraftfuld IDE, der er specielt designet til Python-udvikling. Selvom det understøtter mange andre programmeringssprog, fungerer det bedst til Python. Det har kodefuldførelse, syntaksfremhævning og fejlfindingsfunktioner skræddersyet til Python.
Desuden gør det kommentering i Python meget mere effektivt. Det giver navigationsfunktioner, der hjælper dig med nemt at springe til specifikke kommentarer.
Få forskellige kommentarskabeloner og opret brugerdefinerede kommentarskabeloner effektivt i Pycharm.
Desuden lader redaktørens refaktoreringsværktøjer dig nemt opdatere eller rette kommentarer.
Konklusion
Det er nødvendigt at følge kodestandarder gennem hele kodeudviklingsprocessen og obligatorisk for at skrive produktionsklar kode, da din kode bør kunne læses af alle andre udviklere og testere.
En vigtig praksis for at skabe en læsbar kode er ved at skrive kommentarer. Kommentarer er tilgængelige på næsten alle programmeringssprog. Men med denne artikel bør du nu vide, hvordan du skriver Python-kommentarer, deres typer og den bedste praksis, du skal følge, mens du skriver kommentarer.
Desuden er de bedste kodeeditorer, der hjælper dig med kommentarstyring, listet ned.