Megjegyzések hozzáadása az ASP-hez

• Lehet 19, 2024

Időnként az egyszerű dolgok zavarják az embereket. Hogyan adhat hozzá megjegyzéseket az ASP-kódhoz, hogy ez jobban olvasható és dokumentálható legyen?

Nagyon egyszerű - csak egy idézetet (') kell tenni az ASP sor elejére. Tehát a kódod így néz ki -

'inicializálja a változókat'
CurrMonth = kérés ("m")
CurrDay = kérés ("d")

Ne feledje, hogy hozzászólást írtam ÉS után utána. Nem kell ezt tenned. De a TextPad szerkesztőt használom (amit nagyon ajánlom), és ez automatikusan kiemeli a dolgokat, az aposztrófa kezdő és végpontja alapján. Tehát azáltal, hogy a megjegyzésem mindkét végére egyet ráteszek, mindegyiket más színűvé változtatom.

A megjegyzéseket NEM értelmezik, így bármit belefoglalhat bennük. Ugyanakkor, bár a megjegyzések fontosak ahhoz, hogy nyomon követhessék, mit csinálsz, nem javaslom, hogy egy csomó megjegyzés kerüljön a kódba. Ne felejtse el, hogy a teljes fájlt meg kell értelmezni és feldolgozni, mielőtt az eredményt elküldik a végfelhasználónak. Ha megjegyzéseiben megírja a Háború és Béke témát, akkor eltart egy ideig, mire ez a fájl megérkezik a végfelhasználóhoz - ez azt jelenti, hogy feladhatják és eljuthatnak másutt. Azt szeretné, ha az élő ASP-oldalak a lehető legegyszerűbbek lennének.

Ezért azt javaslom, hogy tegyen megjegyzéseket minden nagyobb kódblokk fölé, tehát ha be kell jelentkeznie, és hónapokkal később meg kell hibáznia, akkor emlékszik arra, amit tett. Talán adjon hozzá egy vagy két sort a tetejére a legutóbbi változtatás dátumával és a szerző nevével. De hagyja külön az összes robusztus dokumentációt. Az ASP-kód elsődleges célja a weboldal létrehozása a felhasználó számára - ebben az értelemben a gyors cselekvés elsődleges fontosságú.