Kommentare in Python - Erstellen der Kommentare in Python

Inhaltsverzeichnis:

Anonim

Einführung in Kommentare in Python

Es ist wichtig, den Ablauf der Programmierung zu verstehen, was man programmiert und wofür. Im Allgemeinen verwendet ein Programmierer dazu Kommentare, um zu zeigen, wozu dieser Code dient, welche Methode zur Codierung verwendet wird und welche Logik dahinter steckt. Diese Kommentare haben keinen Einfluss auf den Code, bieten jedoch ein Layout für die auszuführenden Aktionen. Das Schreiben von Kommentaren im Code hilft, den Code zu verbessern, da ein Programmierer bei der Optimierung prüft, was verbessert werden muss, und wenn Kommentare die verwendete Methode anzeigen, ist es einfach, das Programm zu optimieren. Durch Kommentare in Python können auch die anderen Entwickler das Programm kennen und verstehen. Es wird empfohlen, eine ausreichende Anzahl von Kommentaren zu verwenden, damit der Code im Rückblick nicht verwirrend wird.

Syntaxarten in Python

In Python gibt es zwei Arten von Syntaxen, die für Kommentare verwendet werden:

#: Is used to comment on one line.

Triple quotes (“): To comment more than one line.

In allen Programmiersprachen wurde eine Syntax definiert, um zu identifizieren, was was ist. Ein Programm wird mit einer Reihe von Syntaxen definiert, um z. B. eine Zeile in c zu schließen. Wir verwenden ein Semikolon ';'. Um den Beginn einer Klasse oder Schleife zu definieren, verwenden wir einen Doppelpunkt ':'. Wie zu sehen ist, haben wir eine andere Syntax, die Teil des Codes ist und sich darauf auswirkt. Es sollte eine Syntax geben, die "complier" sagt, um den kommentierten Teil zu verlassen und mit dem nächsten Schritt fortzufahren, da Kommentare nichts mit der Ausgabe zu tun haben. Es ist also wirklich sehr wichtig, die Kommentare vom tatsächlichen Code zu unterscheiden, damit sie nicht mit dem tatsächlichen Programm verwechselt werden.

Erstellen von Kommentaren in Python

Ein Programmierer muss seinem Programm einen Kommentar hinzufügen, um es verständlicher zu machen. Wo können Sie nun Kommentare hinzufügen? Es ist die Wahl einer Person, aber hier sind einige häufige Stellen, an denen das Hinzufügen von Kommentaren ein Programm besser lesbar macht.

  1. Start des Programms
  2. Bei der Definition von Parametern
  3. Eine Klasse definieren
  4. Methoden definieren
  5. Logik für die Methoden / Funktionen
  6. Beschreibung Über die Prozedur
  7. Ausgabe eines Codeteils abgleichen

Die folgenden Punkte wurden unten erklärt:

1. Starten Sie das Programm

Hier definiert ein Programmierer, was die Problemstellung ist und was das Programm benötigt.

2. Beim Definieren von Parametern

Hier kann ein Programmierer Kommentare zu jedem Parameter hinzufügen, wofür er steht und wie er im Programm hilft.

3. Eine Klasse definieren

Ein Programm kann null / eine oder mehrere Klassen enthalten. Daher ist es wichtig, den Zweck der Klasse am Anfang der Kommentare zu definieren. Manchmal wird empfohlen, Kommentare zwischen den Klassen hinzuzufügen, um den Job jeder Zeile in der Klasse zu definieren.

4. Methoden definieren

Methoden sind Funktionen, die Beziehungen zwischen Parametern und der Logik zu deren Manipulation herstellen. Es wird empfohlen, den Job der Methode in Kommentaren zu definieren.

5. Die Logik für die Methoden / Funktionen

Im Allgemeinen kann eine Methode mit einer Reihe von Logikelementen verknüpft sein. Eine kommentierte Beschreibung der einzelnen Logikelemente kann zum Verständnis der vorhandenen Logik beitragen und bei Bedarf an die jeweiligen Anforderungen angepasst werden.

6. Beschreibung des Verfahrens

Für jedes Programm befolgt ein Programmierer eine schrittweise Prozedur und die Definition der Prozedurschritte / der Architektur des Codes in Kommentaren kann zur Verbesserung der Lesbarkeit beitragen.

7. Überprüfen Sie die Ausgabe eines Codeteils

In einigen Fällen müsste ein Programmierer Änderungen am vorhandenen Programm vornehmen. Wenn ein Programm über mehrere Logikfunktionen verfügt und überprüft werden soll, ob alle ordnungsgemäß funktionieren, sollte es über eine Referenzausgabe / eine erwartete Ausgabe verfügen. Das Kommentieren der Ausgänge dieser Logik direkt nach der Logik kann viel Zeit sparen.

Beispiele für Kommentare in Python

Die Beispiele sind unten angegeben:

Kommentare haben keine Auswirkung auf die Ausgabe, verbessern jedoch die Lesbarkeit eines Programms. Hier einige Beispiele für Kommentare in Python.

1. Jeweils eine Zeile kommentieren: Hier führen wir eine Additionsoperation für zwei Variablen durch.

# Performing addition of two variables
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output

Ausgabe: 22

2. Mehrere Zeilen gleichzeitig kommentieren: Manchmal muss eine Beschreibung einer Logik angegeben werden, für die mehrere Zeilen gleichzeitig kommentiert werden müssen. Das Kommentieren einer einzelnen Zeile kann immer wieder anstrengend sein, daher verwenden wir dreifache Anführungszeichen.

"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
"""
a = 12
b = 10
addition = a + b
print(addition)

Ausgabe: 22

3. Eine Zeile und mehrere Zeilen gleichzeitig kommentieren : In den meisten Fällen verwendet ein Programmierer beide Arten von Kommentaren, um die Lesbarkeit des Programms zu verbessern.

"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
“””
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output

Ausgabe: 22

Hier haben wir einige Fälle von Kommentaren gesehen, die in einem Programm verwendet werden. Beim maschinellen Lernen gibt es verschiedene Arten von Modellen, mit denen die Ausgabe vorhergesagt wird. Es müssen Parameter, Hyperparameter und Prozeduren modelliert werden, die im Algorithmus verwendet werden. Das Kommentieren verschiedener Ansätze für das Modell mit unterschiedlichen Parametern kann Wiederholbarkeit und Zeit sparen.

Fazit - Kommentare in Python

Kommentare in einem Programm sind sehr nützlich, um sie zu verstehen. In Python gibt es grundsätzlich zwei Arten von Kommentaren, entweder um eine Zeile mit (#) -Syntax zu kommentieren, oder um mehrere Zeilen mit dreifachen Anführungszeichen (“) zu kommentieren. Kommentare sind nicht dazu da, den Code zu beeinflussen, sondern lediglich eine Beschreibung dessen hinzuzufügen, was dort codiert wird, und Kommentare wären nicht Teil der Ausgabe.

Empfohlene Artikel

Dies ist eine Anleitung zu Kommentaren in Python. Hier besprechen wir die Einführung, das Erstellen von Kommentaren in Python, Beispiele und Syntax usw. Sie können auch unsere anderen vorgeschlagenen Artikel durchgehen, um mehr zu erfahren -

  1. In Python tauschen
  2. Python-Befehle
  3. Reverse Engineering mit Python
  4. Eintauschen in C
  5. Variablen in JavaScript
  6. Reverse Engineering | Verwendet | Ethische Fragen
  7. Wie funktionieren Kommentare in PHP? | Beispiele