Přidávání komentářů v ASP

• Duben 29, 2024

Někdy jsou to jednoduché věci, které lidi pletou. Jak přidáte komentáře do svého kódu ASP, aby byl lépe čitelný a dokumentovaný?

Je to velmi snadné - na začátek řádku ASP zadáte pouze jednu nabídku ('). Takže váš kód může vypadat takto:

'inicializovat proměnné'
CurrMonth = žádost ("m")
CurrDay = žádost ("d")

Všimněte si, že jsem dal apostrof před A po svém komentáři. Nemusíte to dělat. Používám však editor TextPad (což vřele doporučuji) a automaticky zdůrazňuje věci na základě toho, kde apostrof začíná a končí. Takže tím, že jeden na každý konec mých komentářů, já jsem je všechny jiné barvy.

Komentáře NENÍ interpretovány, takže do nich můžete vložit, co chcete. Přestože jsou komentáře důležité pro sledování toho, co děláte, NEDoporučuji do vašeho kódu vkládat tuny komentářů. Pamatujte, že před odesláním výsledku koncovému uživateli musí být celý soubor analyzován a zpracován. Pokud do svých komentářů napíšete válku a mír, bude chvíli trvat, než se tento soubor dostane ke konečnému uživateli - to znamená, že se mohou vzdát a jít jinde. Chcete, aby vaše živé stránky ASP byly co nejefektivnější.

Doporučuji tedy vložit komentáře nad každý hlavní blok kódu, takže pokud musíte jít a ladit jej o měsíce později, můžete si vzpomenout, co jste dělali. Možná na konec přidejte řádek nebo dva s posledním datem změny a jménem autora. Veškerou robustní dokumentaci však ponechte oddělenou. Primárním účelem kódu ASP je nakonec vytvořit webovou stránku pro uživatele - a v tomto smyslu je rychlá akce prvořadá.

Video Návody: The Sims Comments Logic (PART 4) (Duben 2024).