Hinzufügen von Kommentaren zum Code

Wenn Sie Code schreiben, ist es eine gute Praxis, Kommentare zur Beschreibung des Codes hinzuzufügen. Kommentare ermöglichen es anderen, Ihren Code zu verstehen, und können eine Gedächtnisstütze sein, wenn Sie später darauf zurückkommen. Beim Entwickeln und Testen von Code können Sie auch Kommentare verwenden, um Code, der nicht ausgeführt werden muss, auszukommentieren.

Im Live-Editor können Sie Textzeilen vor und nach dem Code einfügen, um einen Prozess oder Code zu beschreiben. Textzeilen bieten zusätzliche Flexibilität wie Standardformatierungsoptionen und das Einfügen von Bildern, Hyperlinks und Gleichungen. Weitere Informationen finden Sie unter Create Live Scripts in the Live Editor.

Hinzufügen von Kommentaren

Verwenden Sie das Prozentzeichen (%), um Kommentare zum MATLAB®-Code hinzuzufügen. Kommentarzeilen können überall in einer Codedatei erscheinen, und Sie können Kommentare an das Ende einer Codezeile anhängen.

Beispiel:

% Add up all the vector elements.
y = sum(x)           % Use the sum function.

Auskommentieren von Code

Verwenden Sie die Blockkommentar-Operatoren, %{ und %}, um mehrere Codezeilen auszukommentieren. Die %{- und %}-Operatoren müssen allein in den Zeilen stehen, die dem Hilfstextblock unmittelbar vorausgehen und folgen. Fügen Sie keinen weiteren Text in diese Zeilen ein.

Beispiel:

a = magic(3);
%{
sum(a)
diag(a)
sum(diag(a))
%}
sum(diag(fliplr(a)))

Um eine Auswahl auszukommentieren, markieren Sie die Codezeilen, gehen Sie auf die Registerkarte Editor oder Live Editor und klicken Sie im Abschnitt Code auf die Kommentar-Registerkarte . Sie können auch Strg+R eingeben. Um die ausgewählten Codezeilen entzukommentieren, klicken Sie auf die Registerkarte zum Auskommentieren oder geben Sie Strg+Umschalt+R ein. Verwenden Sie auf macOS-Systemen Befehl+/ zum Kommentieren und Befehl+Option+/ zum Auskommentieren. Verwenden Sie auf Linux®-Systemen Strg+/ zum Kommentieren und Strg+Umschalt+/ zum Auskommentieren.

Verwenden Sie zum Auskommentieren eines Teils einer Anweisung, der sich über mehrere Zeilen erstreckt, eine Ellipse (...) anstelle eines Prozentzeichens. Beispiel:

header = ['Last Name, ',      ...
          'First Name, ',     ...
      ... 'Middle Initial, ', ...
          'Title']

Umbrechen von Kommentaren

Wenn Sie Kommentare im Editor oder Live-Editor eingeben, wird der Text standardmäßig umgebrochen, wenn er eine Spaltenbreite von 75 erreicht. Im Editor und Live-Editor werden Kommentare nicht umgebrochen, wenn sie folgende Bestandteile enthalten:

  • Abschnittstitel (mit %% beginnende Kommentare)

  • Langer zusammenhängender Text, wie z. B. URLs

  • Aufzählungspunkte (mit * oder # beginnender Text) auf die vorangehende Zeile

Um zu ändern, wo der Kommentartext umgebrochen wird, oder um den automatischen Kommentarumbruch zu deaktivieren, gehen Sie auf die Registerkarte Home und klicken Sie im Abschnitt Environment auf Settings. Wählen Sie MATLAB > Editor/Debugger > MATLAB Language und passen Sie die Comment formatting-Einstellungen an.

Vor R2025a: Wählen Sie stattdessen MATLAB > Editor/Debugger > Language.

Wenn ein bereits bestehender Kommentare über die aktuelle Spaltenbreite hinausgeht, können Sie den Kommentar automatisch umbrechen, indem Sie auf die Registerkarte Editor oder Live Editor gehen und im Abschnitt Code auf die Kommentarumbruch-Registerkarte klicken. Nehmen wir zum Beispiel an, Sie haben diesen langen Text in einer kommentierten Zeile.

% This is a code file that has a comment that is a little more than 75 columns wide.
disp('Hello, world')
Wenn der Cursor auf der Zeile steht, gehen Sie auf Editor oder Live Editor und klicken Sie im Abschnitt Code auf die Kommentarumbruch-Registerkarte . Der Kommentar wird in die nächste Zeile umgebrochen:
% This is a code file that has a comment that is a little more than 75
% columns wide.
disp('Hello, world')

Rechtschreibprüfung in Kommentaren

Sie können Kommentaren auf Rechtschreibfehler überprüfen. Um die Rechtschreibprüfung zu aktivieren, gehen Sie auf die Registerkarte View und aktivieren Sie die Schaltfläche Spelling. Wörter mit einem möglichen Rechtschreibfehler sind blau unterstrichen. Um den Fehler zu beheben, klicken Sie auf das Wort und wählen Sie eine der vorgeschlagenen Korrekturen aus. Sie können den Fehler auch ignorieren oder das markierte Wort zu Ihrem lokalen Wörterbuch hinzufügen. Um mit der Tastatur zwischen den Fehlern zu navigieren, verwenden Sie Alt+F7 und Alt+Shift+F7.

Die Rechtschreibprüfung in MATLAB-Codedateien und Live-Codedateien (.m und .mlx) wird in US-Englisch unterstützt. Um Wörter aus Ihrem lokalen Wörterbuch zu entfernen, gehen Sie auf Ihren MATLAB-Einstellungsordner (der Ordner, der beim Ausführen von prefdir zurückgegeben wird) und bearbeiten Sie die Datei dict/en_US_userDictionary.tdi.

Siehe auch

Themen

Externe Websites