Inhaltsverzeichnis:

Wie füge ich in Visual Studio Kommentare zu XML hinzu?
Wie füge ich in Visual Studio Kommentare zu XML hinzu?

Video: Wie füge ich in Visual Studio Kommentare zu XML hinzu?

Video: Wie füge ich in Visual Studio Kommentare zu XML hinzu?
Video: Top Level Statements in C# 10 - Einfach erklärt! (Visual Studio 2022) 2024, November
Anonim

So fügen Sie XML-Kommentare für ein Codeelement ein

  1. Geben Sie /// in C# ein, oder ''' in Visual Basic .
  2. Wählen Sie im Menü Bearbeiten die Option IntelliSense > Kommentar einfügen .
  3. Wählen Sie aus dem Rechtsklick- oder Kontextmenü auf oder direkt über dem Codeelement Snippet > Kommentar einfügen .

Außerdem, wie schreibe ich Kommentare in XML?

Wenn du möchtest Kommentar eine einzige Zeile in der XML Code, fügen Sie Ihren Cursor am Anfang einer Zeile ein, die Sie möchten Kommentar aus. Geben Sie ein Kleiner-als-Symbol gefolgt von einem Ausrufezeichen und zwei Bindestrichen ein. Bewegen Sie den Cursor an das Ende der Zeile und geben Sie dann zwei Striche gefolgt von einem Größer-als-Symbol ein.

Man kann sich auch fragen, wie ich Code in C# auskommentiere. Zu Code ein Kommentar , geben Sie einen doppelten Schrägstrich gefolgt von ein Kommentar . Sie können diese Technik verwenden, um a. hinzuzufügen Kommentar in einer eigenen Zeile oder um a. hinzuzufügen Kommentar nach dem Code auf einer Linie. Oft, wenn du Code , Du möchtest vielleicht Kommentar einen ganzen Block von Code Aussagen.

Zweitens, was sind XML-Kommentare in C#?

Eine davon ist XML Dokumentation Kommentare , manchmal genannt XML-Kommentare , die mit einem dreifachen Schrägstrich beginnt - ///. XML-Kommentare kann von der IntelliSense-Funktion von Visual Studio und VS Code verwendet werden, um Informationen zu einem Typ oder Member anzuzeigen; Diese Informationen stammen aus dem, was Sie in Ihre Codedokumentation eingegeben haben.

Wie dokumentiert man Code?

Best Practices für das Schreiben von Dokumentationen:

  1. Einschließen Eine README-Datei, die enthält.
  2. Problemverfolgung für andere zulassen.
  3. Schreiben Sie eine API-Dokumentation.
  4. Dokumentieren Sie Ihren Code.
  5. Wenden Sie Codierungskonventionen an, z. B. Dateiorganisation, Kommentare, Namenskonventionen, Programmierpraktiken usw.
  6. Fügen Sie Informationen für Mitwirkende hinzu.

Empfohlen: