Selv om kommentarer prim\u00e6rt er for udviklere<\/a>, kan det at skrive effektive kommentarer ogs\u00e5 hj\u00e6lpe med at producere fremragende dokumentation til brugerne af din kode. Ved hj\u00e6lp af dokumentgeneratorer som Sphinx<\/a> for Python-projekter kan kommentarer i din kode give indhold til din dokumentation.<\/p>\n Lad os kigge n\u00e6rmere p\u00e5 kommentering i Python.<\/p>\n If\u00f8lge PEP 8 Style Guide for Python<\/a> er der flere ting, som man skal v\u00e6re opm\u00e6rksom p\u00e5, n\u00e5r man skriver kommentarer:<\/p>\n I Python er en linje erkl\u00e6ret som en kommentar, n\u00e5r den begynder med symbolet Inline-kommentarer giver korte beskrivelser af variabler og simple operationer og skrives p\u00e5 samme linje som kodeangivelsen:<\/p>\n Kommentaren forklarer kodens funktion i samme udsagn som koden.<\/p>\n Blokkommentarer bruges til at beskrive kompleks logik i koden. Blokkommentarer i Python er opbygget p\u00e5 samme m\u00e5de som inline-kommentarer – den eneste forskel er, at blokkommentarer skrives p\u00e5 en separat linje:<\/p>\n Bem\u00e6rk, at n\u00e5r du bruger blokkommentarer, skrives kommentarerne over den kode, som de forklarer. Python PEP8 Style Guide dikterer, at en kodelinje ikke b\u00f8r indeholde mere end nioghalvfjerds tegn, og inline-kommentarer skubber ofte linjerne over denne l\u00e6ngde. Derfor skrives blokkommentarer for at beskrive koden p\u00e5 separate linjer.<\/p>\n Python underst\u00f8tter ikke native kommentarer p\u00e5 flere linjer, hvilket betyder, at der ikke er nogen s\u00e6rlig bestemmelse til at definere dem. P\u00e5 trods af dette bruges kommentarer, der str\u00e6kker sig over flere linjer, ofte.<\/p>\n Du kan oprette en flerlinjekommentar ud fra flere enkeltlinjekommentarer ved at indlede hver linje med Du kan ogs\u00e5 bruge syntaksen for flerlinjestrenge. I Python kan du definere flerlinjestrenge ved at omslutte dem med I koden ovenfor er strengen med flere linjer ikke tildelt en variabel, hvilket f\u00e5r strengen til at fungere som en kommentar. Ved k\u00f8rselstid ignorerer Python strengen, og den bliver ikke inkluderet i bytekoden. Udf\u00f8relse af ovenst\u00e5ende kode giver f\u00f8lgende output:<\/p>\n Ud over at g\u00f8re din kode l\u00e6sbar tjener kommentarer ogs\u00e5 nogle s\u00e6rlige form\u00e5l i Python, f.eks. planl\u00e6gning af fremtidige kodetilf\u00f8jelser og generering af dokumentation.<\/p>\n I Python er docstrings kommentarer p\u00e5 flere linjer, der forklarer, hvordan en given funktion eller klasse skal bruges. Dokumentationen af din kode forbedres ved at oprette docstrings af h\u00f8j kvalitet. N\u00e5r du arbejder med en funktion eller klasse og bruger den indbyggede funktion Python PEP 257<\/a> indeholder en standardmetode til at deklarere docstrings i Python, som vist nedenfor:<\/p>\n I koden ovenfor gav docstring detaljer om, hvordan den tilknyttede funktion fungerer. Med dokumentationsgeneratorer som Sphinx kan denne docstring bruges til at give brugerne af dit projekt et overblik over, hvordan denne metode skal bruges.<\/p>\n En docstring defineret lige under funktions- eller klassesignaturen kan ogs\u00e5 returneres ved hj\u00e6lp af den indbyggede funktion Funktionskaldet Attributten N\u00e5r du skriver kode, er der lejligheder, hvor du \u00f8nsker at fremh\u00e6ve visse linjer eller hele blokke der kr\u00e6ver forbedring. Disse opgaver markeres med TODO-kommentarer. TODO-kommentarer er praktiske, n\u00e5r du planl\u00e6gger opdateringer eller \u00e6ndringer af din kode, eller hvis du \u00f8nsker at informere projektets brugere eller samarbejdspartnere om, at der stadig mangler at blive skrevet bestemte dele af koden i filen.<\/p>\n TODO-kommentarer skal ikke skrives som pseudokode – de skal blot kort forklare funktionen af den endnu ikke skrevne kode.<\/p>\n TODO-kommentarer og blokkommentarer p\u00e5 \u00e9n linje ligner hinanden meget, og den eneste forskel mellem dem er, at TODO-kommentarer skal begynde med et TODO-pr\u00e6fiks:<\/p>\n Det er vigtigt at bem\u00e6rke, at selv om mange IDE’er kan fremh\u00e6ve disse kommentarer for programm\u00f8ren, ser Python-fortolkeren ikke TODO-kommentarer anderledes p\u00e5 TODO-kommentarer end blokkommentarer.<\/p>\n Der er en r\u00e6kke bedste praksis, der b\u00f8r f\u00f8lges, n\u00e5r man skriver kommentarer for at sikre p\u00e5lidelighed og kvalitet. Nedenfor er nogle tips til at skrive kommentarer af h\u00f8j kvalitet i Python.<\/p>\n Kommentarer, der fastsl\u00e5r det indlysende, tilf\u00f8jer ikke nogen v\u00e6rdi til din kode og b\u00f8r undg\u00e5s. For eksempel:<\/p>\n Denne kommentar er ikke nyttig, da den blot angiver, hvad koden g\u00f8r, uden at forklare, hvorfor det skal g\u00f8res. Kommentarer b\u00f8r forklare “hvorfor” snarere end “hvad” i den kode, de beskriver.<\/p>\n Omskrevet p\u00e5 en mere brugbar m\u00e5de kunne eksemplet ovenfor se s\u00e5ledes ud:<\/p>\n Hold dine kommentarer korte og let forst\u00e5elige. De b\u00f8r v\u00e6re skrevet i standardprosa, ikke pseudokode, og b\u00f8r erstatte behovet for at l\u00e6se den egentlige kode for at f\u00e5 et generelt overblik over, hvad den g\u00f8r. For mange detaljer eller komplekse kommentarer g\u00f8r ikke programm\u00f8rens arbejde lettere. For eksempel:<\/p>\n Kommentaren ovenfor giver mere information end n\u00f8dvendigt for l\u00e6seren. I stedet for at specificere kernen i logikken b\u00f8r kommentarer give et generelt resum\u00e9 af koden. Denne kommentar kan omskrives som:<\/p>\n Identifikatorer b\u00f8r anvendes med omhu i kommentarer. Hvis man \u00e6ndrer identifikatornavne eller -betegnelser, kan det forvirre l\u00e6seren. Eksempel:<\/p>\n Ovenst\u00e5ende kommentar n\u00e6vner N\u00e5r du skriver kode, vil du gerne overholde DRY-princippet (don’t repeat yourself) og undg\u00e5 WET-princippet (write everything twice).<\/p>\n Dette g\u00e6lder ogs\u00e5 for kommentarer. Undg\u00e5 at bruge flere udsagn til at beskrive din kode, og pr\u00f8v at samle kommentarer, der forklarer den samme kode, i en enkelt kommentar. Det er dog vigtigt at v\u00e6re forsigtig, n\u00e5r du sl\u00e5r kommentarer sammen: En sk\u00f8desl\u00f8s sammenl\u00e6gning af flere kommentarer kan resultere i en stor kommentar, der overtr\u00e6der stilvejledninger og er sv\u00e6r for l\u00e6seren at f\u00f8lge med i.<\/p>\n Husk, at kommentarer skal reducere l\u00e6setiden for koden.<\/p>\n I koden ovenfor er kommentarerne un\u00f8digt fragmenterede og kan sl\u00e5s sammen til en enkelt kommentar:<\/p>\n S\u00f8rg for, at kommentarer er indrykket p\u00e5 samme niveau som den kode, de beskriver. N\u00e5r de ikke er det, kan de v\u00e6re sv\u00e6re at f\u00f8lge.<\/p>\n Denne kommentar er f.eks. ikke indrykket eller placeret korrekt:<\/p>\n Den kan omskrives som f\u00f8lger:<\/p>\n Kommentarer er en vigtig del af at skrive forst\u00e5elig kode. Den investering du foretager i at skrive en kommentar er en investering, som dit fremtidige jeg – eller andre udviklere, der skal arbejde p\u00e5 din kodebase – vil s\u00e6tte pris p\u00e5. Ved at kommentere kan du ogs\u00e5 f\u00e5 en dybere indsigt i din kode.<\/p>\n I denne vejledning har du l\u00e6rt mere om kommentarer i Python, herunder de forskellige typer Python-kommentarer, hvorn\u00e5r du skal bruge dem hver is\u00e6r, og de bedste fremgangsm\u00e5der, du skal f\u00f8lge, n\u00e5r du opretter dem.<\/p>\n At skrive gode kommentarer er en f\u00e6rdighed, der skal studeres og udvikles. For at \u00f8ve dig i at skrive kommentarer kan du overveje at g\u00e5 tilbage og tilf\u00f8je kommentarer til nogle af dine tidligere projekter. Hvis du vil have inspiration og se bedste praksis i praksis, kan du se godt dokumenterede Python-projekter p\u00e5 GitHub.<\/p>\n N\u00e5r du er klar til at g\u00f8re dine egne Python-projekter live, kan Kinstas Applikation Hosting-platform<\/a> f\u00e5 din kode fra GitHub til skyen<\/a> p\u00e5 f\u00e5 sekunder.<\/p>\n","protected":false},"excerpt":{"rendered":" Kommentarer er noter, som programm\u00f8rer tilf\u00f8jer til deres kode for at forklare, hvad det er meningen, at koden skal g\u00f8re. De compilere eller fortolkere, der oms\u00e6tter …<\/p>\n","protected":false},"author":275,"featured_media":48378,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_kinsta_gated_content":false,"_kinsta_gated_content_redirect":"","footnotes":""},"tags":[],"topic":[729],"class_list":["post-47969","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","topic-python"],"yoast_head":"\nKommentarer i Python<\/h2>\n
\n
#<\/code>. N\u00e5r Python-fortolkeren st\u00f8der p\u00e5 #<\/code> i din kode, ignorerer den alt efter dette symbol og producerer ikke nogen fejl. Der er to m\u00e5der at deklarere kommentarer p\u00e5 \u00e9n linje p\u00e5: inline kommentarer og blokkommentarer.<\/p>\nInline-kommentarer<\/h3>\n
border = x + 10 # Make offset of 10px<\/code><\/pre>\nBlokkommentarer<\/h3>\n
import csv\nfrom itertools import groupby\n\n# Get a list of names in a sequence from the csv file\nwith open('new-top-firstNames.csv') as f:\n file_csv = csv.reader(f)\n\n# Skip the header part: (sr, name, perc)\nheader = next(file_csv)\n \n# Only name from (number, name, perc)\npersons = [ x[1] for x in file_csv]\n\n# Sort the list by first letter because \n# The groupby function looks for sequential data.\npersons.sort(key=lambda x:x[0])\ndata = groupby(persons, key=lambda x:x[0])\n\n# Get every name as a list \ndata_grouped = {}\nfor k, v in data:\n # Get data in the form \n # {'A' : [\"Anthony\", \"Alex\"], \"B\" : [\"Benjamin\"]}\n data_grouped[k] = list(v)<\/code><\/pre>\nKommentarer p\u00e5 flere linjer<\/h3>\n
#<\/code>:<\/p>\n# interpreter \n# ignores\n# these lines<\/code><\/pre>\n\"\"\"<\/code>, tredobbelte dobbelte anf\u00f8rselstegn eller '''<\/code>, tredobbelte enkeltst\u00e5ende anf\u00f8rselstegn:<\/p>\nprint(\"Multi-Line Comment\")\n\"\"\"\nThis\nString is \nMulti line \n\"\"\"<\/code><\/pre>\nMulti-Line Comment<\/code><\/pre>\n\nS\u00e6rlige kommentarer<\/h2>\n
Python Docstring-kommentarer<\/h3>\n
help(obj)<\/code>, kan docstrings v\u00e6re nyttige til at give et overblik over objektet.<\/p>\nfrom collections import namedtuple\nPerson = namedtuple('Person', ['name', 'age'])\n\n def get_person(name, age, d=False):\n \"\"\"\nReturns a namedtuple(\"name\", \"age\") object.\nAlso returns dict('name', 'age') if arg `d` is True\n\nArguments:\nname \u2013 first name, must be string\nage \u2013 age of person, must be int\nd \u2013 to return Person as `dict` (default=False)\n\n\"\"\"\np = Person(name, age)\nif d:\n return p._asdict()\nreturn p<\/code><\/pre>\nhelp()<\/code>. Funktionen help()<\/code> tager et objekt- eller funktionsnavn som et argument og returnerer funktionens docstrings som output. I eksemplet ovenfor kan help(get_person)<\/code> kaldes for at f\u00e5 vist docstrings, der er knyttet til funktionen get_person<\/code>. Hvis du k\u00f8rer ovenst\u00e5ende kode i en interaktiv shell med -i<\/code> -flaget, kan du se, hvordan denne docstring vil blive analyseret af Python. K\u00f8r ovenst\u00e5ende kode ved at skrive python -i file.py<\/code>.<\/p>\n![\"Sk\u00e6rmbillede:](\"https:\/\/kinsta.com\/wp-content\/uploads\/2022\/12\/parsing-python-docstrings-on-command-line.png\")
help(get_person)<\/code> returnerer en docstring for din funktion. Udgangen indeholder get_person(name, age, d=False)<\/code>, som er en funktionssignatur, som Python automatisk tilf\u00f8jer.<\/p>\nget_person.__ doc__<\/code> kan ogs\u00e5 bruges til at hente og \u00e6ndre docstrings programmatisk. Efter tilf\u00f8jelsen af “Some more new information” i eksemplet ovenfor vises det i det andet kald til help(get_person)<\/code>. Det er dog usandsynligt, at du vil f\u00e5 brug for at \u00e6ndre docstrings dynamisk p\u00e5 k\u00f8rselstid p\u00e5 denne m\u00e5de. <\/p>\nTODO-kommentarer<\/h3>\n
# TODO Get serialized data from the CSV file\n# TODO Perform calculations on the data\n# TODO Return to the user<\/code><\/pre>\nBedste praksis ved skrivning af Python-kommentarer<\/h2>\n
Undg\u00e5 det indlysende<\/h3>\n
x = x + 4 # increase x by 4<\/code><\/pre>\nx = x + 4 # increase the border width<\/code><\/pre>\nHold Python-kommentarer korte og simple<\/h3>\n
# return area by performing, Area of cylinder = (2*PI*r*h) + (2*PI*r*r)\ndef get_area(r,h):\n return (2*3.14*r*h) + (2*3.14*r*r)<\/code><\/pre>\n# return area of cylinder\ndef get_area(r,h):\n return (2*3.14*r*h) + (2*3.14*r*r)<\/code><\/pre>\nBrug identifikatorer med omhu<\/h3>\n
# return class() after modifying argument\ndef func(cls, arg):\n return cls(arg+5)\n<\/code><\/pre>\nclass<\/code> og argument<\/code>, som ikke findes i koden. Denne kommentar kan omskrives som:<\/p>\n# return cls() after modifying arg\ndef func(cls, arg):\n return cls(arg+5)<\/code><\/pre>\nDRY og WET<\/h3>\n
\"># function to do x work\ndef do_something(y):\n # x work cannot be done if y is greater than max_limit\n if y < 400:\n print('doing x work')<\/code><\/pre>\n\"># function to do x if arg:y is less than max_limit\ndef do_something(y):\n if y in range(400):\n print('doing x work')<\/code><\/pre>\n<\/code><\/p>\nKonsistent indrykning<\/h3>\n
for i in range(2,20, 2):\n# only even numbers\n if verify(i):\n# i should be verified by verify()\n perform(x)<\/code><\/pre>\n# only even numbers\nfor i in range(2,20, 2):\n # i should be verified by verify()\n if verify(i):\n perform(x)<\/code><\/pre>\n\nOpsummering<\/h2>\n