[Powered by Google Translate] In diesem Video werden wir diskutieren, Code-Stil, das ist etwas,
das ist in der Nähe und Liebe zu meinem Herzen.
Stil beschreibt, wie Ihr Code formatiert ist, das ist
unabhängig von was der Code tatsächlich tut.
Nicht nur guter Stil erhalten Sie eine bessere Note in CS50,
aber es wird Ihnen auch helfen, Code schreiben, der viel mehr ist
lesbar und wartbar, die, am Ende des Tages,
wird Ihr Leben viel einfacher.
>> Die drei Hauptkomponenten des Code-Stil, dass wir diskutieren,
Dieses Video gibt Kommentare, Formatierung,
und Variablennamen.
Beginnen wir mit Kommentaren.
Erinnern Sie sich, Kommentare keinen Einfluss auf die
Funktionalität Ihres Codes.
Sie nur als hilfreiche Hinweise, die uns als Programmierer dienen.
Gute Kommentare antworten sollte eine der beiden Fragen.
>> Erstens, was bedeutet das Code-Block zu tun?
Dies ist eine kurze und süße Beschreibung des Zwecks der
die Zeilen, die folgen.
Zum Beispiel müssen Sie die Stelle, wo Sie
implementiert ein bestimmtes Merkmal, eine fix
Bug oder etwas ändern.
Ohne Kommentare können Sie brüten über viele Zeilen müssen
Code versucht, um herauszufinden, wo genau dieses Feature ist.
Oder wenn es schon ein paar Tage, da Sie in einem haben gesucht
Ihre Programme, können Sie sich nicht erinnern, was eine bestimmte
Funktion bzw. Schleife macht.
So Kommentare machen reacquainting sich mit
alten Code, oder vertraut sich mit jemand anderem
Code, viel glatter.
Die zweite Frage ein guter Kommentar Antworten Deshalb habe ich
Umsetzung dieser Block in dieser Weise?
Wenn Sie Code schreiben, werden Sie häufig
um Design-Entscheidungen treffen.
Sollte ich eine while-Schleife oder eine for-Schleife hier?
Sollte ich diesen Codeblock in eine separate Funktion?
Mit Kommentaren können Sie dokumentieren Ihr Design
Entscheidungen, die Ihr Code leichter zu verstehen
für andere, kann sich fragen sich genau die gleiche
Design-Fragen, wie sie Ihren Code zu lesen.
Oder sogar selbst, wenn Sie kommen zurück, um einen Block von Code nach
einige Zeit.
>> In C und anderen Sprachen wir in CS50 sehen, es gibt
zwei Möglichkeiten, Hinzufügen von Kommentaren zu Ihrem Code, Inline-Kommentare
und mehrzeilige Kommentare.
In-line Kommentare sind ideal für die Dokumentation Teile des Codes
innerhalb von Funktionen.
Zum Beispiel könnte ein Inline Kommentar beschreiben
Zweck eine for-Schleife oder eine Ecke Fall, bedingt
eine Bedingung.
Multi-line Kommentare sind ideal für die Dokumentation Funktionen.
Wenn Sie eine Funktion schreiben, sollten Sie immer, immer,
immer dokumentieren, was sie mit einem Kommentar tut.
Dies beinhaltet, was die Eingänge für die Funktion, sind, was das
Ausgabe der Funktion ist, und vielleicht deshalb die Funktion ist
umgesetzt in der Weise, dass es ist.
Wenn Sie einer Funktion Signatur zu ändern, kehren
Wert oder Umsetzung, ist es wichtig, auch Aktualisierung der
entsprechende Dokumentation Kommentar.
Ein Missverhältnis zwischen einer Funktion Kommentar und
Umsetzung kann wirklich verwirrend für die Leser.
Ebenso die Schaffung eines mehrzeiligen Kommentar am Anfang
jeder. c oder. h Datei, die Sie schreiben, beschreiben, was die
Datei ist, ist auch eine sehr gute Idee.
>> Wie Sie kommentieren Code sind eine der ersten Fragen, die Sie
haben könnte, nun ja, wie viel sollte ich meinen Code kommentieren?
Es ist oft unnötig, jedes Dokument
einzige Zeile Code.
Zum Beispiel kann eine Linie, die sagt int x = 5 benötigt keine
Kommentar darüber, dass "gesetzt x bis 5", sagt.
Nicht kommentieren genug, obwohl, wie wir gesehen haben, können
Verständnis Ihr Code sehr schwierig.
Also eine gute Faustregel ist es, interessante Bausteine ​​Kommentar
Code, wobei ein Block besteht aus wenigen verbundenen Leitungen.
>> Werfen wir also einen Blick auf ein Beispiel.
Hier ist ein unkommentierte C-Funktion.
Okay, da dies eine Funktion, die erste Sache, die wir brauchen, um hinzuzufügen
wird ein Kommentar zu erklären, was der Funktion Eingänge
sind und was sie tut.
So fügen wir einen mehrzeiligen Kommentar.
Great.
Jetzt wissen wir genau, was unsere Funktion hat.
Wir fügen einige Inline-Kommentare jetzt.
Wir können unseren Code in zwei Blöcke von ähnlichen Linien zu unterteilen.
Leitungen 4 und 5 Konstrukt Saiten auf der Basis von Eingangs-und
Zeilen 6 bis 9 ausgegeben diese
Zeichenfolgen in Songtexten.
Lassen Sie uns also, dass mit Kommentaren zu dokumentieren.
Awesome.
Jetzt ist unsere Funktion wird kommentiert.
>> Beachten Sie, dass Sie unsere Inline-Kommentare müssen nicht komplett nutzen
Sätze oder mit einem Punkt enden.
Es ist wichtig, dass es einen Raum zwischen dem zweiten Schrägstrich
und der Beginn des Kommentars.
Dies ist die Frequenz von Kommentaren in Ihren Programmen
dass Sie für feuern.
Beachten Sie hier, wie wir die beiden Blöcke von verwandten Code getrennt
Innere unserer Chorus-Funktion mit einem zusätzlichen Wagenrücklauf.
>> Dies bringt uns zu der nächsten Komponente der Code-Stil,
Formatierung.
Als ich anfing, Programmierung, schlug ich die Eingabetaste
Schlüssel sehr selten führte die in riesigen, unlesbare
Blobs von Code.
Ich denke ich eigentlich beleidigt meine Lehre Kerl, da sie
war nicht allzu glücklich mit mir.
Optisch Gruppierung Blöcke zugehörigen Code, mit Schlitten
zurückkehrt, kann Ihr Code leichter zu überfliegen und klar
abzugrenzen welche Codezeilen Ihre Kommentare werden erklärt.
That being said, Ausbreiten Ihren Code zu viel, wie mit
zwei oder mehrere Linien zwischen Codeblöcken oder Funktionen können
machen es auch viel weniger lesbar.
>> Einzug ist ein weiterer wichtiger
Aspekt Codeformat.
Immer, immer, immer Gedankenstrich den Körper einer Funktion, Loop,
oder Zustands.
Dies macht deutlich, welche Codezeilen innerhalb eines sind
Schleife, zum Beispiel, und die Codezeilen
außerhalb davon.
CS50 empfiehlt, dass Sie mit vier Räumen Gedankenstrich, aber
wenn Sie etwas anderes wählen, müssen Sie konsequent sein
gesamten Code.
In diesem Sinne empfiehlt CS50, dass Sie Klammern setzen
in einer eigenen Zeile.
Auf diese Weise wird Zahnspangen Line-Up optisch an der gleichen linken
Marge, so ist es kristallklar, wo ein Block beginnt und endet.
Allerdings ist es auch okay, die Klammern auf der gleichen Linie wie ein Ort,
Zustand, beispielsweise um Platz zu sparen.
Wenn Sie dies tun, aber stellen Sie sicher, dass Sie ein Leerzeichen
vor der geschweiften Klammer so ist es nicht smooshed neben einer Schließung
paren oder ein Wort.
>> Wofür Sie sich entscheiden, ist die wichtigste Sache zu sein
konsequente gesamten Code.
Was wir nicht sehen wollen, ist jedoch,
eingerückt geschweiften Klammern.
Dies macht die Klammern aus dem erscheinen getrennt
Zustand, Schleife oder Funktion sie abgrenzen, so dass
der Code schwer zu lesen.
In C und anderen Sprachen, die wir sehen werden, sind geschweiften Klammern
optional für einzeilige Bedingungen oder Schleifen.
Es ist gut, geschweiften Klammern in diesem Fall auslassen, aber wenn
Sie dies tun, stellen Sie sicher, konsequent zu sein
gesamten Code.
>> Bei der Definition von Funktionen, empfiehlt CS50 schreiben Sie die
zurückzukehren Typ der Funktion auf der gleichen Zeile wie der Name
die Funktion.
Allerdings ist es auch OK, um den Rückgabetyp auf eigene schreiben
Linie, die machen Funktionsdefinitionen leichter zu finden kann
Einige Texteditoren.
>> Schließlich sollten Sie Leerzeichen um beinhalten
Schlüsselwörter und Operatoren.
Zum Beispiel kann eine Linie, die sagt int x = 5 ist viel einfacher,
lesen, wenn es Leerzeichen um das Gleichheitszeichen sind.
Ebenso sicher, dass Sie ein Leerzeichen nach Keywords, wenn möchten,
für, und während.
Ohne ein Leerzeichen, könnten diese wie Funktionsaufrufe suchen,
denen sie nicht.
>> Werfen wir also einen Blick auf ein Beispiel für die Anwendung guter Stil
eine schlecht formatierte Code-Block.
Okay, lasst uns von oben zu beginnen.
Wir können sehen, dass der öffnenden geschweiften Klammer der Hauptsache auf die gleiche ist
Linie als der Name der Funktion.
Wenn wir dies tun wollen, muss es einen Raum zwischen sein
die Schließung paren und die Klammer, wie diese.
Empfiehlt jedoch, CS50, dass Zahnspangen stehen
in einer eigenen Zeile.
Also lasst uns das tun.
Jetzt, da wir in den Körper der Hauptfunktion sind, müssen wir
zu starten Einrücken Code; wir den Einsatz
empfohlen vier Leerzeichen.
Weiter sehen wir, dass es keinen Platz um das Gleichheitszeichen
Hier, so fügen wir, dass.
Hier sehen wir, dass es keinen Raum zwischen dem if und der
offenen paren, so wir hinzufügen, dass, zusammen mit einigen Raum um
das Größer-Zeichen.
Auch hier sehen wir es gibt keinen Raum zwischen der Schließung paren und
die öffnende Klammer hier.
Wenn wir diese auf der gleichen Linie gebracht sind, bedarf es
ein Leerzeichen vor dem geschweiften Klammer.
Allerdings sieht es wie der Körper unserer
Bedingung ist nur eine Zeile.
So brauchen wir nicht, um die Klammern überhaupt gehören.
Jetzt müssen wir sicher sein, Gedankenstrich auf den Körper eines jeden
unsere Bedingungen.
Wir wollen auf keinen Fall diese letzte Zeile auf die gleiche sein
Linie als sonst, also lasst drücken Sie die Eingabetaste und Gedankenstrich.
Schließlich, um die schließende geschweifte Klammer für die wichtigsten Bedürfnisse werden
seine eigene Linie.
>> Wir können hier sehen, haben wir zwei verschiedene
Blöcke zugehörigen Code.
Zeilen 4 bis 6 fordert den Benutzer zur Eingabe und der
restlichen Linien anzuzeigen, dass Eingaben an den Benutzer.
So macht es Sinn, etwas Platz zwischen diesen beiden Blöcken setzen
für Klarheit.
Und da gehen wir, jetzt dieser Code ist viel einfacher, mit Lese-
guten Stil.
>> Schließlich wollen wir über unsere dritte Komponente des guten Stils sprechen:
Variablennamen.
Ihre Variablennamen sollte beschreiben die
Wert, den sie darstellen.
Wir noch einmal unseren früheren Beispiel.
Flaschen ist ein guter Name für die Variable, die
darstellt, wieviele Flaschen werden an der Wand gelassen.
Namen wie x oder numBots sind nicht sehr aussagekräftig sind und
nicht gut für die Lesbarkeit des Codes.
Während Variablen durch einen einzigen Buchstaben benannt sind häufig in
Mathematik und in anderen Bereichen, können sie Ihren Code sehr schwer machen
zu verstehen.
Die Ausnahme von dieser Regel ist iterator
Variablen innerhalb von Schleifen.
In for-Schleifen, zum Beispiel, ist es in Ordnung, Variable verwenden
Namen wie i, j und k für die Iteration.
Beim Erstellen Iteratorvariablen innerhalb von Schleifen, ist es
empfohlen, dass Sie dies tun in der Schleife selbst, sondern
als außerhalb der Schleife, so dass wir halten Variablen
Zielfernrohr dicht wie möglich.
>> Auf der anderen Seite, die Anzahl eine variable Name wie Flaschen
links an der Wand ist, während beschreibenden, übermäßig verbose
und nicht notwendig.
In der Veranstaltung, die Sie wollen, um eine Variable mit erstellen
mehrere Wörter, trennen diese Worte mit einem Unterstrich.
Zum Beispiel ist is_ready viel besser lesbar als isReady.
Es ist gut, mehrere Variablen auf der gleichen Linie zu erklären.
Allerdings, wenn Sie dies tun, nicht initialisieren einige Variablen, sondern
andere nicht.
Das heißt, so etwas wie int Groschen, Pfennige
Semikolon, ist OK.
Aber int Groschen = 0, Pennies
Semikolon nicht.
>> Schließlich bei der Deklaration Zeiger, ist es empfehlenswert
Sie platzieren das Sternchen neben dem Zeiger-Typ, nicht
der Name der Variablen.
So int * p wird als int empfohlen
Raum * p.
Whoo!
Also das scheint wie eine Menge von Regeln
erinnern, aber keine Sorge.
Wenn es jemals in Zweifel, zögern Sie nicht, um CS50 die beziehen
Online-Styleguide.
>> Lassen Sie uns schnell eine Zusammenfassung der wichtigsten
Punkte Code-Stil.
Zunächst kommentieren Sie den Code.
Immer, immer, immer zu beschreiben, welche Funktionen zu tun
mit einem mehrzeiligen Kommentar und kommentieren alle paar Zeilen
Code-Zeile.
Second.
Seien Sie konsequent mit Ihrem Code Formatierung.
Achten Sie auf Ihre Platzierung und Verwendung von Klammern
sowie Abstand um Schlüsselwörter und Operatoren.
Schließlich wählen Sie beschreibende Variablennamen.
Variablen sollten beschreiben die Wert, den sie darstellen, sondern
sollte dich nicht ewig geben.
>> Und das ist es.
All dies wird schnell zur zweiten Natur, wie Sie sich
Schreiben mehr und mehr Code, und Sie werden Kodierung
mit Stil in kürzester Zeit.
Mein Name ist Tommy, und dies ist CS50.