Dodajanje komentarjev v ASP

• Maj 17, 2024

Včasih preproste stvari zmedejo ljudi. Kako dodate komentarje k svoji ASP kodi, da jo naredite bolj berljivo in dokumentirano?

To je zelo enostavno - na začetku svoje vrstice ASP preprosto vstavite en sam citat ('). Torej bi lahko vaša koda izgledala tako -

"inicializiranje spremenljivk"
CurrMonth = zahteva ("m")
CurrDay = zahteva ("d")

Upoštevajte, da sem apostrof postavil pred in po svojem komentarju. Tega vam ni treba storiti. Uporabljam pa urejevalnik TextPad (kar toplo priporočam) in samodejno osvetli stvari glede na to, kje se začne in konča apostrof. Torej tako, da položim enega na vsak konec svojih komentarjev, jih spremenim v drugo barvo.

Komentarji se NE razlagajo, zato lahko vanj vstavite karkoli želite. Kljub temu, da so komentarji pomembni, da spremljate, kaj počnete, NE priporočam, da v svojo kodo vnesete tono komentarjev. Ne pozabite, da morate celotno datoteko razčleniti in obdelati, preden se rezultat pošlje končnemu uporabniku. Če v komentarje napišete vojno in mir, bo minilo nekaj časa, preden ta datoteka pride do vašega končnega uporabnika - kar pomeni, da bi se ji lahko odpovedali in odšli drugam. Želite, da so vaše spletne strani ASP v živo čim bolj racionalizirane.

Zato priporočam, da dodate komentarje nad vsakim večjim blokom kode, tako da, če morate vknjižiti in odpraviti napake mesece pozneje, se lahko spomnite, kaj ste počeli. Mogoče na vrhu dodajte vrstico ali dve z zadnjim datumom spremembe in imenom avtorja. Toda vso zanesljivo dokumentacijo pustite ločeno. Primarni namen kode ASP je na koncu izdelati spletno stran za uporabnika - in v tem smislu je hitro ukrepanje primarnega pomena.

Navodila Video: Data Visualization and D3 by David Chouinard (Maj 2024).