I den här artikeln kommer vi att fördjupa oss i konceptet med flerradskommentarer i Python, och tillhandahålla en omfattande definition tillsammans med illustrativa exempel i programmeringsspråket Python om hur man kommenterar flera rader i Pytonorm .

755 chmod

Vad är en flerradskommentar i Python?

Flerradskommentarer i Python hänvisar till ett textblock eller uttalanden som används i förklarings- eller dokumentationssyfte i koden. Till skillnad från enradskommentarer som betecknas med hash-symbolen (#), är flerradskommentarer omgivna av tredubbla citattecken (``) eller tredubbla enkla citattecken (`’`). Dessa kommentarer används ofta för att ge detaljerade förklaringar, dokumentation eller anteckningar om koden, och de kan sträcka sig över flera rader. Även om Python inte har en specifik syntax för flerradskommentarer, uppnår användning av tredubbla citattecken en liknande effekt, eftersom tolken ignorerar den bifogade texten.

Typer av flerradskommentarer i Python

Det finns två sätt som vi kan lägga till Python flerradskommentarer i vår kod. De är följande:

• På varandra följande enradskommentarer
• Använda en flerradssträng som kommentar
• Använder omvänt snedstreck

Kommentera flera rader i Python med på varandra följande enkelradskommentarer

I Pytonorm , används hash-tecknet (#) för att kommentera raden. En kö kommentarer i Python behöver inte vara enbart text för att förklara koden, de kan också användas för att förhindra Python från att exekvera kod. Hash-tecknet bör placeras före varje rad för att betraktas som flerradskommentarer i Python.

Exempel: Konsekutiv enradskommentar

Här innehåller de två första raderna ett hash-tecken(#) och tolken förhindrar att de två raderna körs. Sedan skriver den ut Python-kommentarerna och slutligen kommer den att förhindra att den sista raden körs.

# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')>

Produktion:

Python Comments>

Kommentera flera rader i Python med en flerradssträng som kommentar

Python flerradskommentarer kan också inkluderas i en avgränsare (). Återigen ska det inte finnas något blanksteg mellan avgränsare (). De är användbara när kommentarstexten inte får plats på en rad och därför måste sträcka sig över raderna. Den här typen av strängliteral ignoreras eftersom den inte tilldelas någon variabel. Vi kan komma åt dessa strängar med __doc__.

Exempel: Använda en flerradssträng som en kommentar

Flerradiga kommentarer används för att kommentera mer än en rad. Den första raden är en enradskommentar. Den andra och tredje raden kan kommenteras med hjälp av trippelcitattecken( ). Detta förhindrar exekvering av ovanstående kod. Slutligen skriver den ut matematik i utgången. Men om dessa Python flerradskommentarer placeras direkt efter en funktion eller klasssignatur, blir dessa till docstrings .

# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')>

Produktion:

Mathematics>

Kommentera flera rader i Python med omvänd snedstreck

En metod för att skapa flerradskommentarer i Python innebär att man använder omvänt snedstreck (``) i slutet av varje rad för att använda linjefortsättningsfunktionen, vilket gör att kommentaren kan sträcka sig till nästa rad. Denna linjefortsättningsmetod är mindre vanlig än andra tillvägagångssätt som på varandra följande enradskommentarer eller flerradssträngar och används främst för kodläsbarhet när det är nödvändigt att bryta en kommentar över flera rader.

Exempel : I det här exemplet, kommentarerna som börjar med#>utökas till flera rader med bakåtstrecket (>) i slutet av varje rad. Omvänt snedstreck anger att kommentaren fortsätter på nästa rad. Den här metoden kan vara till hjälp för att förbättra kodläsbarheten när du har långa kommentarer.

sorteringsmatris i java

# Using backslash for multiline comments # This is a long comment  # that spans multiple lines  # using the backslash continuation method. # Code continues below print('Hello, World!')>

Utgång:

Hello, World!>

Docstrings i Python

De docstring är en inbyggd funktion i Python, som används för att associera dokumentation som har skrivits med Python-moduler, funktioner, klasser och metoder. Den läggs till precis under funktionerna, modulerna eller klasserna för att beskriva vad de gör. I Python görs docstringen sedan tillgänglig via Python __doc__ attribut.

Exempel: Docstrings i Python

I det här exemplet, efter att multiply()-funktionen har definierats, deklarerade vi en docstring-kommentar med tre citattecken. Sedan skriver vi ut docstringen med attributet __doc__.

def multiply(a, b):  '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>

Produktion:

Multiplies the value of a and b>

Skillnad mellan kommentarer och Docstring i Python

Låt oss se skillnaden mellan Python-kommentarer och Docstring: