Komentarų pridėjimas ASP
Kartais tai supainioja žmones. Kaip galite pridėti komentarus prie savo ASP kodo, kad jis būtų lengviau skaitomas ir dokumentuojamas?

Tai labai lengva - jūs tiesiog įdėjote vieną citatą (') savo ASP eilutės pradžioje. Taigi jūsų kodas gali atrodyti taip -

'inicijuoti kintamuosius'
„CurrMonth“ = užklausa („m“)
„CurrDay“ = užklausa („d“)

Atkreipkite dėmesį, kad prieš ir po mano komentaro pateikiau apostrofą. Jūs neprivalote to daryti. Bet aš naudoju „TextPad“ redaktorių (kurį labai rekomenduoju) ir jis automatiškai pabrėžia dalykus atsižvelgiant į tai, kur prasideda ir baigiasi apostrofas. Taigi, uždėdamas po vieną ant kiekvieno savo komentaro galo, aš paverčiu juos vis kita spalva.

Komentarai NĖRA interpretuojami, todėl galite į juos įdėti bet ką. Tačiau, nors komentarai yra svarbūs norint sekti tai, ką darote, aš nerekomenduoju į savo kodą įtraukti daug komentarų. Atminkite, kad visas jūsų failas turi būti išanalizuotas ir apdorotas prieš siunčiant rezultatą galutiniam vartotojui. Jei komentaruose rašysite karą ir taiką, praeis šiek tiek laiko, kol tas failas pateks į jūsų galutinį vartotoją - tai reiškia, kad jie gali atsisakyti ir nuvykti kitur. Norite, kad tiesioginiai ASP puslapiai būtų kiek įmanoma supaprastinti.

Taigi aš rekomenduoju pateikti komentarus virš kiekvieno didesnio kodo bloko, taigi, jei jūs turite prisijungti ir derinti jį po mėnesių, galite prisiminti, ką darėte. Gal pridėkite eilutę ar dvi viršuje su paskutine pakeitimo data ir autoriaus vardu. Visą patikimą dokumentaciją palikite atskirai. Pagrindinis ASP kodo tikslas yra sukurti tinklalapį vartotojui. Šiuo atžvilgiu labai svarbu atlikti greitus veiksmus.

Vaizdo Instrukcijos: JavaScript for Web Apps, by Tomas Reimers and Mike Rizzo (Kovo 2024).