Hinzufügen von Kommentaren in ASP
Manchmal sind es die einfachen Dinge, die die Menschen verwirren. Wie fügen Sie Ihrem ASP-Code Kommentare hinzu, um ihn lesbarer und dokumentierter zu machen?

Es ist sehr einfach - Sie setzen einfach ein einfaches Anführungszeichen (') an den Anfang Ihrer ASP-Zeile. Ihr Code könnte also so aussehen -

'Variablen initialisieren'
CurrMonth = Anfrage ("m")
CurrDay = Anfrage ("d")

Beachten Sie, dass ich vor UND nach meinem Kommentar ein Apostroph eingefügt habe. Das musst du nicht tun. Aber ich benutze den TextPad-Editor (den ich sehr empfehlen kann) und er hebt automatisch Dinge hervor, die darauf basieren, wo ein Apostroph beginnt und endet. Wenn ich also an jedem Ende meiner Kommentare einen anbringe, färbe ich sie alle in eine andere Farbe.

Kommentare werden NICHT interpretiert, sodass Sie alles einfügen können, was Sie möchten. Obwohl Kommentare wichtig sind, um zu verfolgen, was Sie tun, empfehle ich NICHT, eine Menge Kommentare in Ihren Code einzufügen. Denken Sie daran, dass Ihre gesamte Datei analysiert und verarbeitet werden muss, bevor das Ergebnis an den Endbenutzer gesendet wird. Wenn Sie War and Peace in Ihre Kommentare schreiben, wird es eine Weile dauern, bis diese Datei bei Ihrem Endbenutzer ankommt - was bedeutet, dass er aufgeben und woanders hingehen kann. Sie möchten, dass Ihre Live-ASP-Seiten so rational wie möglich sind.

Ich empfehle daher, Kommentare über jeden wichtigen Codeblock einzufügen. Wenn Sie ihn also Monate später debuggen müssen, können Sie sich daran erinnern, was Sie getan haben. Fügen Sie oben möglicherweise ein oder zwei Zeilen mit dem letzten Änderungsdatum und dem Namen des Autors hinzu. Lassen Sie jedoch alle robusten Dokumentationen getrennt. Der Hauptzweck von ASP-Code besteht letztendlich darin, eine Webseite für einen Benutzer zu erstellen - und in diesem Sinne ist schnelles Handeln von größter Bedeutung.

Video-Anleitungen: Adding Data to an ASP.NET Core Website | ASP.NET Core 101 [3 of 13] (March 2024).