Inline-Kommentare
Lektion 7 von 28 im Kurs Clean Code - Schreibe besseren Code mit Python von Coddy.
Inline-Kommentare erklären eine einzelne Anweisung in einem Codeabschnitt.
- Schreiben Sie Inline-Kommentare in derselben Zeile wie die Anweisung, auf die sie sich beziehen.
- Trennen Sie Inline-Kommentare durch zwei oder mehr Leerzeichen von der Anweisung.
- Beginnen Sie mit einem
#und einem einzelnen Leerzeichen. - Verwenden Sie sie nicht, um Offensichtliches zu erklären.
Zum Beispiel,
result = check(name) # Check if name is goodIn den meisten Fällen werden Sie Kommentarblöcke gegenüber Inline-Blöcken bevorzugen.
Aufgabe
EinfachDir wird ein kleiner Code gegeben, der eine kleine Berechnung durchführt, um das salary zu erhöhen; schreibe einen Inline-Kommentar, der diese Zeile erklärt.
Dies ist wahrscheinlich eine offensichtliche Erklärung, aber für unsere Übung werden wir es trotzdem machen...
Probier es selbst
salary = 1000
salary = salary * 1.05