Додавање коментара у АСП-у

• Април 19, 2024

Понекад то једноставне ствари збуне људе. Како додате коментаре свом АСП коду како бисте га учинили читљивијим и документованијим?

То је врло лако - само ставите један цитат (') на почетак своје линије АСП. Дакле, ваш код може изгледати овако -

'иницијализација варијабли'
ЦуррМонтх = захтев ("м")
ЦуррДаи = захтев ("д")

Имајте на уму да сам ставио апостроф пре И након свог коментара. Не морате то да радите. Али користим ТектПад едитор (који топло препоручујем) и он аутоматски наглашава ствари на основу места где почиње и завршава апостроф. Дакле, стављајући један на сваки крај мојих коментара, претварам их све другачијом бојом.

Коментари се НЕ тумаче тако да у њих можете уложити све што желите. Међутим, иако су коментари важни да бисте пратили шта радите, НЕ препоручујем да унесете тону коментара у свој код. Имајте на уму да цела датотека мора бити анализирана и обрађена пре него што се резултат пошаље крајњем кориснику. Ако у коментаре напишете Рат и мир, проћи ће неко време док та датотека стигне до вашег крајњег корисника - што значи да би могли одустати и отићи негде другде. Желите да ваше АСП странице уживо буду што поједностављене.

Зато препоручујем да коментаре додате изнад сваког великог блока кода, тако да ако морате да уђете у систем и отклоните погрешку, месецима касније можете се сетити шта сте радили. Можда додајте линију или две на врху са последњим датумом промене и именом аутора. Али сву робусну документацију оставите одвојено. Примарна сврха АСП кода на крају је креирање веб странице за корисника - и у том смислу су брзе акције од примарне важности.

Видео Упутства: JavaScript for Web Apps, by Tomas Reimers and Mike Rizzo (Април 2024).