Bedste praksis til at følge og forbedre din kodning
Programmering afspejler måden at tænke på for at beskrive de trin, du tog for at løse et problem ved hjælp af en computer. At kommentere din kode hjælper med at forklare din tankeproces igen. Det hjælper andre med at forstå din kode bedre. Ved at kommentere kan du nemmere fejlfinde din kode. Det giver også mulighed for at genbruge koden igen i andre programmer.
Gode vs. dårlige kommentarer
Kommentarer er vigtige for koden. Nogle gange, utilsigtet, skriver vi dårlige kommentarer eller ubrugelige kommentarer, som ikke har nogen nytte. Eksempel:
num = 10 ##Tildeling af num en værdi på 10
Lad os nu se et bedre eksempel med mere nyttig indsigt og kommentarer:
taxoil = 1,10 ## Definition af en afgift på 10 % på olie
taxcoal = 1,30 ## definition af en 30 % afgift på kul
Den bedste praksis til at skrive bedre kommentarer er kun at tilføje kommentarer til de kodelinjer, der har deres formål er ikke indlysende.
Typer af kommentarer
En grundlæggende python-kommentar starter med et enkelt #. En streng bag # vil ikke blive set som en kode af tolken. For at være præcis kan en kommentar skrives på tre måder – helt på sin egen linje, ved siden af en kodesætning og som en flerlinjet kommentarblok.
Enkeltlinjekommentarer
strong>
En enkelt linjekommentar kan laves ved at bruge et # og efterfølges af en tekst, der indeholder en beskrivelse af linjen.
Du kan også skrive en kommentar ved siden af et udsagn.
Flere linjers kommentarer
Kommentarer med flere linjer kan udføres på to måder, den ene er ved at bruge flere # eller ved at bruge “”” “”” Docstrings.
Nedenfor er et eksempel af flere kommentarer ved hjælp af # Lad os nu se et eksempel på flere linjers kommentarer, der bruger “”” “”” Docstrings.
Skrivning af kommentarer — Sådan starter du
Det er altid en bedre øv dig i at starte med en kommentar i dit program. Medtag først arbejdet med den kode, du skriver, og skriv derefter i næste linje om resultatet af den kode, der forventes. Skriv derefter nogle linjer om udviklerne af koden. Skriv om deres personlige oplysninger og adresse eller nogle sociale links for at forbinde. Så i den næste linje, skriv om eventuelle licensoplysninger, du har, og til sidst skal du blot tilføje hjælpe-e-mail eller kontaktoplysninger for at nå udvikleren for enhver form for fejl.
Skriv kommentarer — Funktioner
Funktioner er et sæt instruktioner, der er skrevet uden for hovedkoden og kan bruges, når det er nødvendigt. Funktioner er meget praktiske at bruge, og de fleste python-udviklere foretrækker funktioner frem for klasser. At skrive kommentarer i funktion er lidt anderledes.
I den første linje skal du skrive en kort beskrivelse af, hvad funktionen gør. Nævn derefter alle argumenterne for funktionen i de næste par linjer. Dernæst bør du angive nogle oplysninger om funktionens returtype og til sidst nogle noter, du vil tilføje til dine læsere eller fremtidige dig.