\u00c4ven om kommentarer i f\u00f6rsta hand \u00e4r till f\u00f6r utvecklare<\/a> s\u00e5 kan den \u00e4ven vara till hj\u00e4lp f\u00f6r anv\u00e4ndarna av din kod. Effektiva kommentarer kan exempelvis skapa en utm\u00e4rkt dokumentation. Med hj\u00e4lp av dokument-generatorer som Sphinx<\/a> f\u00f6r Pythonprojekt s\u00e5 kan kommentarer i din kod ge inneh\u00e5ll till din dokumentation.<\/p>\n L\u00e5t oss titta under huven p\u00e5 kommentarer i Python.<\/p>\n Enligt Python PEP 8 Style Guide<\/a> s\u00e5 finns det flera saker som man b\u00f6r t\u00e4nka p\u00e5 n\u00e4r man skriver kommentarer:<\/p>\n I Python s\u00e5 deklareras en rad som en kommentar n\u00e4r den b\u00f6rjar med symbolen Inline-kommentarer ger korta beskrivningar av variabler och enkla operationer och skrivs p\u00e5 samma rad som kodf\u00f6rklaringen:<\/p>\n Kommentaren f\u00f6rklarar kodens funktion i samma uttalande som koden.<\/p>\n Blockkommentarer anv\u00e4nds f\u00f6r att beskriva en komplex logik i koden. Blockkommentarer i Python \u00e4r uppbyggda p\u00e5 samma s\u00e4tt som inline-kommentarer – den enda skillnaden \u00e4r att blockkommentarer skrivs p\u00e5 en separat rad:<\/p>\n Observera att n\u00e4r blockkommentarer anv\u00e4nds s\u00e5 skrivs kommentarerna ovanf\u00f6r den kod som de f\u00f6rklarar. Pythons PEP8 Style Guide f\u00f6reskriver att en kodrad inte f\u00e5r inneh\u00e5lla mer \u00e4n sjuttionio tecken, och inline-kommentarer driver ofta upp raderna \u00f6ver denna l\u00e4ngd. Av den anledningen s\u00e5 skrivs blockkommentarer f\u00f6r att beskriva koden p\u00e5 separata rader.<\/p>\n Python har inte naturligt st\u00f6d f\u00f6r kommentarer med flera rader, vilket inneb\u00e4r att det inte finns n\u00e5gon s\u00e4rskild best\u00e4mmelse f\u00f6r att definiera dem. Trots detta s\u00e5 anv\u00e4nds ofta kommentarer som str\u00e4cker sig \u00f6ver flera rader.<\/p>\n Du kan skapa en flerradskommentar av flera enradskommentarer genom att inleda varje rad med Du kan \u00e4ven anv\u00e4nda syntaxen f\u00f6r str\u00e4ngar med flera rader. I Python s\u00e5 kan du definiera str\u00e4ngar med flera rader genom att omsluta dem med I koden ovan s\u00e5 tilldelas str\u00e4ngen med flera rader inte en variabel, vilket g\u00f6r att str\u00e4ngen fungerar som en kommentar. Vid k\u00f6rning s\u00e5 ignorerar Python str\u00e4ngen och den inkluderas inte i bytekoden. Exekvering av ovanst\u00e5ende kod ger f\u00f6ljande utdata:<\/p>\n F\u00f6rutom att g\u00f6ra din kod l\u00e4sbar s\u00e5 har kommentarer \u00e4ven vissa speciella syften i Python, t.ex. att planera framtida kodtill\u00e4gg och skapa dokumentation.<\/p>\n Docstrings i python \u00e4r kommentarer p\u00e5 flera rader som f\u00f6rklarar hur man anv\u00e4nder en viss funktion eller klass. Dokumentationen av din kod f\u00f6rb\u00e4ttras genom skapandet av h\u00f6gkvalitativa docstrings. N\u00e4r du arbetar med en funktion eller klass och anv\u00e4nder den inbyggda funktionen Python PEP 257<\/a> tillhandah\u00e5ller en standardmetod f\u00f6r att deklarera docstrings i Python, som visas nedan:<\/p>\n I koden ovan s\u00e5 ger docstring detaljer om hur den tillh\u00f6rande funktionen fungerar. Med dokumentations-generatorer som Sphinx s\u00e5 kan denna docstring anv\u00e4ndas f\u00f6r att ge anv\u00e4ndarna av ditt projekt en \u00f6versikt \u00f6ver hur man anv\u00e4nder denna metod.<\/p>\n En dokumentationsstr\u00e4ng som definieras precis under funktions- eller klassignaturen kan ocks\u00e5 returneras med hj\u00e4lp av den inbyggda funktionen Funktionsanropet Attributet N\u00e4r du skriver kod s\u00e5 finns det tillf\u00e4llen d\u00e5 du vill markera vissa rader eller hela block f\u00f6r f\u00f6rb\u00e4ttring. Dessa uppgifter markeras med TODO-kommentarer. TODO-kommentarer \u00e4r praktiska n\u00e4r du planerar uppdateringar eller \u00e4ndringar av din kod. Det kan \u00e4ven h\u00e4nda att du vill informera projektets anv\u00e4ndare eller samarbetspartners om att specifika avsnitt av filens kod \u00e5terst\u00e5r att skriva.<\/p>\n TODO-kommentarer ska inte skrivas som pseudokod – de beh\u00f6ver bara ge en kortfattad f\u00f6rklaring av funktionen hos den \u00e4nnu inte skrivna koden.<\/p>\n TODO-kommentarer och enradiga blockkommentarer \u00e4r mycket lika varandra, och den enda skillnaden mellan dem \u00e4r att TODO-kommentarer m\u00e5ste b\u00f6rja med ett TODO-prefix:<\/p>\n Det \u00e4r viktigt att notera att \u00e4ven om m\u00e5nga IDE: er kan markera dessa kommentarer f\u00f6r programmeraren, s\u00e5 g\u00f6r Python-tolken inte skillnad mellan TODO-kommentarer och blockkommentarer.<\/p>\n Det finns ett antal rekommenderade metoder som b\u00f6r f\u00f6ljas n\u00e4r man skriver kommentarer, f\u00f6r att s\u00e4kerst\u00e4lla tillf\u00f6rlitlighet och kvalitet. Nedan s\u00e5 f\u00f6ljer n\u00e5gra tips f\u00f6r att skriva h\u00f6gkvalitativa kommentarer i Python.<\/p>\n Kommentarer som anger det uppenbara tillf\u00f6r inget v\u00e4rde till din kod och b\u00f6r undvikas. Exempelvis:<\/p>\n Den kommentaren \u00e4r inte anv\u00e4ndbar, eftersom den bara anger vad koden g\u00f6r utan att f\u00f6rklara varf\u00f6r den m\u00e5ste g\u00f6ras. Kommentarer b\u00f6r f\u00f6rklara ”varf\u00f6r” snarare \u00e4n ”vad” i den kod som de beskriver.<\/p>\n Omskrivet p\u00e5 ett mer anv\u00e4ndbart s\u00e4tt skulle exemplet ovan kunna se ut s\u00e5 h\u00e4r:<\/p>\n H\u00e5ll dina kommentarer korta och l\u00e4ttf\u00f6rst\u00e5eliga. De b\u00f6r vara skrivna i standardprosa, inte i pseudokod, och b\u00f6r ers\u00e4tta behovet av att l\u00e4sa sj\u00e4lva koden f\u00f6r att f\u00e5 en allm\u00e4n \u00f6verblick \u00f6ver vad den g\u00f6r. Alltf\u00f6r detaljerade eller komplexa kommentarer g\u00f6r inte programmerarens arbete l\u00e4ttare. Exempelvis:<\/p>\n Kommentaren ovan ger mer information \u00e4n vad som \u00e4r n\u00f6dv\u00e4ndigt f\u00f6r l\u00e4saren. Ist\u00e4llet f\u00f6r att specificera k\u00e4rnlogiken s\u00e5 b\u00f6r kommentarerna ge en allm\u00e4n sammanfattning av koden. Denna kommentar kan skrivas om till f\u00f6ljande:<\/p>\n Identifierare b\u00f6r anv\u00e4ndas med f\u00f6rsiktighet i kommentarer. Om man \u00e4ndrar namn eller fall p\u00e5 identifierare s\u00e5 kan detta f\u00f6rvirra l\u00e4saren. Exempelvis:<\/p>\n Ovanst\u00e5ende kommentar n\u00e4mner N\u00e4r du skriver kod s\u00e5 b\u00f6r du f\u00f6lja DRY-principen (upprepa inte dig sj\u00e4lv) och undvika WET-principen (skriva allting tv\u00e5 g\u00e5nger).<\/p>\n Detta g\u00e4ller \u00e4ven f\u00f6r kommentarer. Undvik att anv\u00e4nda flera uttalanden f\u00f6r att beskriva din kod och f\u00f6rs\u00f6k att sl\u00e5 ihop kommentarer som f\u00f6rklarar samma kod till en enda kommentar. Det \u00e4r dock viktigt att vara f\u00f6rsiktig n\u00e4r du sl\u00e5r ihop kommentarer: en slarvig sammanslagning av flera kommentarer kan resultera i en enorm kommentar som bryter mot stilguider och som \u00e4r sv\u00e5r f\u00f6r l\u00e4saren att f\u00f6lja.<\/p>\n Kom ih\u00e5g att kommentarer ska minska l\u00e4stiden f\u00f6r koden.<\/p>\n I koden ovan s\u00e5 \u00e4r kommentarerna on\u00f6digt splittrade och kan sl\u00e5s samman till en enda kommentar:<\/p>\n Se till att kommentarerna \u00e4r indragna p\u00e5 samma niv\u00e5 som den kod de beskriver. De kan annars vara sv\u00e5ra att f\u00f6lja.<\/p>\n Den h\u00e4r kommentaren \u00e4r exempelvis inte indragen eller placerad p\u00e5 r\u00e4tt s\u00e4tt:<\/p>\n Den kan skrivas om p\u00e5 f\u00f6ljande s\u00e4tt:<\/p>\n Kommentarer \u00e4r en viktig del i skrivandet av en begriplig kod. Den investering som du g\u00f6r n\u00e4r du skriver en kommentar \u00e4r en investering som ditt framtida jag – eller andra utvecklare som beh\u00f6ver arbeta med din kodbas – kommer att uppskatta. Genom att kommentera s\u00e5 kan du \u00e4ven f\u00e5 djupare insikter i din kod.<\/p>\n I den h\u00e4r guiden s\u00e5 har du l\u00e4rt dig mer om kommentarer i Python, inklusive de olika typerna av Pythonkommentarer. Du har l\u00e4rt dig n\u00e4r du ska anv\u00e4nda var och en av dem och de rekommenderade metoderna n\u00e4r du skapar dem.<\/p>\n Att skriva bra kommentarer \u00e4r en f\u00e4rdighet som m\u00e5ste studeras och utvecklas. F\u00f6r att \u00f6va sig p\u00e5 att skriva kommentarer s\u00e5 kan du \u00f6verv\u00e4ga att g\u00e5 tillbaka och l\u00e4gga till kommentarer i n\u00e5gra av dina tidigare projekt. F\u00f6r inspiration och f\u00f6r att se b\u00e4sta praxis s\u00e5 kan du kolla in v\u00e4ldokumenterade Pythonprojekt p\u00e5 GitHub.<\/p>\n N\u00e4r du \u00e4r redo att omvandla dina egna Python-projekt till live s\u00e5 kan Kinsta’s plattform f\u00f6r applikationshosting<\/a> f\u00e5 din kod fr\u00e5n GitHub till molnet<\/a> p\u00e5 n\u00e5gra sekunder.<\/p>\n","protected":false},"excerpt":{"rendered":" Kommentarer \u00e4r anteckningar som programmerare l\u00e4gger till i sin kod f\u00f6r att f\u00f6rklara vad koden ska g\u00f6ra. De kompilatorer eller tolkar som omvandlar kod till handling …<\/p>\n","protected":false},"author":275,"featured_media":48921,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_kinsta_gated_content":false,"_kinsta_gated_content_redirect":"","footnotes":""},"tags":[],"topic":[807],"class_list":["post-48533","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","topic-python"],"yoast_head":"\nKommentarer i Python<\/h2>\n
\n
#<\/code>. N\u00e4r Python-tolken st\u00f6ter p\u00e5 #<\/code> i din kod s\u00e5 ignorerar den allt som f\u00f6ljer efter den symbolen och ger inte upphov till n\u00e5got fel. Det finns tv\u00e5 s\u00e4tt att deklarera kommentarer p\u00e5 en enda rad: inline-kommentarer och blockkommentarer.<\/p>\nInline-kommentarer<\/h3>\n
border = x + 10 # Make offset of 10px<\/code><\/pre>\nBlockkommentarer<\/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 flera rader<\/h3>\n
#<\/code>:<\/p>\n# interpreter \n# ignores\n# these lines<\/code><\/pre>\n\"\"\"<\/code>, tredubbla dubbla citationstecken eller '''<\/code>, tredubbla enkla citationstecken:<\/p>\nprint(\"Multi-Line Comment\")\n\"\"\"\nThis\nString is \nMulti line \n\"\"\"<\/code><\/pre>\nMulti-Line Comment<\/code><\/pre>\n\nS\u00e4rskilda kommentarer<\/h2>\n
Kommentarer till Python Docstring<\/h3>\n
help(obj)<\/code> s\u00e5 kan docstrings vara till hj\u00e4lp f\u00f6r att ge en \u00f6versikt \u00f6ver 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> tar ett objekt- eller funktionsnamn som argument och returnerar funktionens dokumentstr\u00e4ngar som utmatning. I exemplet ovan s\u00e5 kan help(get_person)<\/code> anropas f\u00f6r att visa de dokumentstr\u00e4ngar som \u00e4r kopplade till funktionen get_person<\/code>. Om du k\u00f6r koden ovan i ett interaktivt skal med flaggan -i<\/code> s\u00e5 kan du se hur den h\u00e4r dokumentstr\u00e4ngen analyseras av Python. K\u00f6r ovanst\u00e5ende kod genom att skriva python -i file.py<\/code>.<\/p>\n![\"Pythons](\"https:\/\/kinsta.com\/wp-content\/uploads\/2022\/12\/parsing-python-docstrings-on-command-line.png\")
help(get_person)<\/code> returnerar en docstring f\u00f6r din funktion. Utdatan inneh\u00e5ller get_person(name, age, d=False)<\/code>, som \u00e4r en funktionssignatur som Python l\u00e4gger till automatiskt.<\/p>\nget_person.__ doc__<\/code> kan ocks\u00e5 anv\u00e4ndas f\u00f6r att h\u00e4mta och \u00e4ndra docstrings programmatiskt. Efter att ha lagt till ”Some more new information” i exemplet ovan s\u00e5 visas detta i det andra anropet till help(get_person)<\/code>. Det \u00e4r dock osannolikt att du beh\u00f6ver \u00e4ndra docstrings dynamiskt vid k\u00f6rning p\u00e5 det h\u00e4r s\u00e4ttet.<\/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>\nB\u00e4sta praxis n\u00e4r du skriver Pythonkommentarer<\/h2>\n
Undvik det uppenbara<\/h3>\n
x = x + 4 # increase x by 4<\/code><\/pre>\nx = x + 4 # increase the border width<\/code><\/pre>\nH\u00e5ll Pythonkommentarerna korta och snygga<\/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>\nAnv\u00e4nd identifierare med f\u00f6rsiktighet<\/h3>\n
# return class() after modifying argument\ndef func(cls, arg):\n return cls(arg+5)\n<\/code><\/pre>\nclass<\/code> och argument<\/code>, som inte finns i koden. Kommentaren kan skrivas om till f\u00f6ljande:<\/p>\n# return cls() after modifying arg\ndef func(cls, arg):\n return cls(arg+5)<\/code><\/pre>\nDRY och 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>\nKonsekvent indragning<\/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\nSammanfattning<\/h2>\n