Lägga till kommentarer i ASP

• April 25, 2024

Ibland är det de enkla sakerna som förvirrar människor. Hur lägger du till kommentarer till din ASP-kod för att göra den mer läsbar och dokumenterad?

Det är väldigt enkelt - du lägger bara en enda offert (') i början av din ASP-serie. Så din kod kan se ut så här -

"initiera variabler"
CurrMonth = begäran ("m")
CurrDay = begäran ("d")

Observera att jag lägger en apostrof före OCH efter min kommentar. Du behöver inte göra det. Men jag använder TextPad-redigeraren (som jag rekommenderar starkt) och den belyser automatiskt saker baserade på var en apostrof börjar och slutar. Så genom att sätta en i varje ände av mina kommentarer, förvandlar jag dem alla till en annan färg.

Kommentarer tolkas INTE så att du kan lägga in vad du vill ha i dem. Men även om kommentarer är viktiga för att hålla reda på vad du gör, rekommenderar jag INTE att lägga massor av kommentarer i din kod. Kom ihåg att hela filen måste analyseras och behandlas innan resultatet skickas till slutanvändaren. Om du skriver krig och fred i dina kommentarer kommer det att ta ett tag innan den filen kommer till din slutanvändare - vilket betyder att de kan ge upp och gå någon annanstans. Du vill att dina live ASP-sidor ska vara så strömlinjeformade som möjligt.

Så jag rekommenderar att du lägger in kommentarer ovanför varje större kodblock, så om du måste gå in och felsöka det månader senare kan du komma ihåg vad du gjorde. Kanske lägg till en rad eller två längst upp med det sista ändringsdatumet och författarens namn. Men lämna all robust dokumentation separat. Det primära syftet med ASP-koden i slutändan är att skapa en webbsida för en användare - och i den bemärkelsen är snabb handling av största vikt.

Video Instruktioner: "GÖR EN VIDEO DÄR DU DÖDAR DIG SJÄLV" | Läser elaka och konstiga kommentarer (April 2024).