Додавання коментарів в ASP

• Може 19, 2024

Іноді саме прості речі бентежать людей. Як ви додаєте коментарі до свого коду ASP, щоб зробити його більш зрозумілим та задокументованим?

Це дуже просто - ви просто ставите одну цитату (') на початку свого рядка ASP. Тож ваш код може виглядати приблизно так -

'ініціалізувати змінні'
CurrMonth = запит ("м")
CurrDay = запит ("d")

Зауважте, що я поставив апостроф перед І після свого коментаря. Вам не потрібно цього робити. Але я використовую редактор TextPad (який дуже рекомендую), і він автоматично виділяє речі, залежно від місця початку і закінчення апострофа. Отож, розміщуючи по одному на кожному кінці моїх коментарів, я перетворюю їх на всі інші кольори.

Коментарі НЕ трактуються, тому ви можете вкладати в них все, що завгодно. Однак, хоча коментарі важливі для того, щоб відслідковувати, що ви робите, я НЕ рекомендую вносити в ваш код багато коментарів. Пам'ятайте, що весь файл повинен бути проаналізований та оброблений, перш ніж результат буде відправлений кінцевому користувачеві. Якщо ви напишите Війну і мир у своїх коментарях, пройде певний час, перш ніж цей файл потрапить до вашого кінцевого користувача - це означає, що вони можуть відмовитись і піти в інше місце. Ви хочете, щоб ваші живі сторінки ASP були максимально спрощеними.

Тому я рекомендую розміщувати коментарі вище кожного основного блоку коду, тому якщо вам доведеться зайти і налагодити його через кілька місяців, ви можете згадати, що ви робили. Можливо, додайте рядок чи два вгорі з останньою датою зміни та прізвищем автора. Але залиште всю надійну документацію окремо. Основна мета коду ASP зрештою - створити веб-сторінку для користувача - і в цьому сенсі швидкі дії мають першочергове значення.

Відео Інструкція: Data Visualization and D3 by David Chouinard (Може 2024).