Как да добавите коментари към вашата PHP програма


Всеки програмист има своето мнение за това каква информация трябва да бъде включена в програмния код. Повечето програмисти добавят коментари с кода си, за да напомнят на себе си и на всеки друг какво прави кодът и как го прави. Когато решавате каква информация да включите, запитайте се какво би трябвало да ви бъде казано за програмата, ако някой друг е написал програмата, а сега сте помолени да я стартирате и поддържате.

Повечето от програмите, които пишете, ще имат повече от една страница с код. Всяка страница с код ще бъде запазена като PHP програмен файл. (filename.php3) В програмния файл има две места, където ще искате да добавите някои информационни коментари.

  1. В горната част на всеки програмен файл ще включите обща информация за програмата.

    • В самия връх на файла и веднага след отварящия PHP маркер ще поставите името на файла като HelloWorld.php3.
    • След това ще добавите известие за авторски права, което се нарича собственик на авторските права на програмата.
    • Ако вашата програма ще има повече от една страница код, ще споменете, че това е една страница от по-голяма програма и ще посочите името на тази програма.
    • Също така ще искате да включите кратко описание на целта на програмата и как тя работи.
    • Последно ще добавите всяка информация за отказ от отговорност и лицензиране. Например това може да бъде лиценз, написан от вашия адвокат, или GNU General Public License, който сте свободни да използвате във всяка ваша безплатна програма. Можете да изтеглите копие на този лиценз от уебсайта на Фондацията за свободен софтуер. Ще обсъдим това по-подробно в отделен урок.

  2. Втората област, в която ще искате да добавите коментари, е самият код в началото на всеки основен раздел от кода. Включете кратък коментар за това, каква задача ще изпълнява конкретният раздел.
Има три начина да добавите коментари към програмния си код.

// коментарите отиват тук
Това е основният коментар в PHP стил. Всичко от същия ред и това, което идва след двете // ще бъде игнорирано от сървъра и не обработено като програмен код.

# коментара отидете тук
Това е коментарът в стил черупка. Всичко на същия ред и това, което идва след # ще бъде игнорирано от сървъра и не се обработва като програмния код.

/*
коментарите отиват тук
коментарите отиват тук
коментарите отиват тук
*/
Това е коментарът в стил С. Всичко, което е между отварянето / * и затварянето * /, ще бъде игнорирано от сървъра и не ще бъде обработено като програмен код. Можете да използвате този стил, когато имате повече от един ред коментари, каквито сме обсъждали в този урок. Кликнете тук за пример.




Самая красивая мелодия на свете Для Души! Послушайте! Волшебная флейта! Релакс (Може 2021)



Тагове Статия: Как да добавяте коментари към вашата PHP програма, PHP, PHP, динамични уеб страници, езици за уеб скриптове, php, релационни бази данни, MySQL, PHP версия 4, програмиране на php, уроци за php, статии за php, ресурси на PHP, Apache, изходен код, уеб разработка , Уеб администратори, справка, съвети, приложения, основи на php, php тагове, променливи, оператори

Цветя и алергии

Цветя и алергии

здраве и фитнес