Zawartość

• Kroki
• Część 1 z 2: Style
• Część 2 z 2: Używanie
• Porady

Komentarz to rodzaj notatki, której można użyć do wyjaśnienia celu i znaczenia fragmentu kodu. Pracując w PHP, będziesz mieć kilka opcji pisania komentarzy, które pochodzą ze starych, dobrze znanych języków programowania: poprzez wprowadzanie jedno- lub wieloliniowych komentarzy C. Możesz użyć komentarzy, aby uniemożliwić działanie fragmentu kodu lub po prostu zachować rekordy.

Kroki

Część 1 z 2: Style

1. 1 Pojedyncze komentarze do krótkich postów. Jeśli chcesz zostawić krótki komentarz, użyj jednoliniowego kodu komentarza. Komentarz rozszerzy się tylko do końca linii lub bloku kodu. Takie komentarze działają tylko w tagach PHP i będą odczytywane tylko wtedy, gdy zostaną umieszczone w HTML.

   ?php // To jest standardowy (C++) sposób tworzenia komentarza jednowierszowego # Możesz również użyć tego stylu Unix do utworzenia komentarza jednowierszowego?> var13 ->

2. 2 Używaj komentarzy wielowierszowych do pisania długich komentarzy lub kodu testowego. Komentarze wielowierszowe są bardzo przydatne do pisania długich wyjaśnień i zapobiegania przetwarzaniu segmentu kodu. Przeczytaj sekcję Użycie, aby uzyskać wskazówki dotyczące korzystania z komentarzy wielowierszowych.

   ?php / * Oto jak sformatować komentarz wielowierszowy. Cały tekst do końca tagu zostanie dołączony do komentarza * / / * Niektórzy ludzie lubią umieszczać * na początku każdego wiersza * dodatkowe punktory. Poprawi to * czytelność dużych komentarzy, chociaż nie jest to wymagane. * /?> var13 ->

Część 2 z 2: Używanie

1. 1 Użyj komentarzy, aby zostawić notatki na temat kondycji kodu. Nie musisz tego robić dla każdej linii kodu, ponieważ inni programiści mogą łatwo rozgryźć dobrze napisany kod. Komentarze są przydatne, gdy Twój kod wykonuje niestandardowe lub nieoczywiste funkcje.

   // Utwórz żądanie curl $ session = curl_init ($ request); // Powiedz curl, aby używał HTTP POST curl_setopt (sesja $, CURLOPT_POST, true);

2. 2 Zostaw komentarze, aby nie zapomnieć, co zrobiłeś z kodem. Podczas pracy nad projektem komentarze sprawią, że nie zapomnisz, gdzie skończyłeś. Zostaw komentarz dla kodu, który nie działa poprawnie lub który jeszcze nie został ukończony.

   // Zanim przejdziesz do następnego kroku, sprawdź dwa razy wyjście tego programu echo "Hello World!";

3. 3 Zostaw komentarz do kodu, który planujesz udostępnić. Jeśli planujesz współpracować z innymi programistami lub zamierzasz udostępnić swój kod publicznie, komentarze pomogą innym zrozumieć, jak działa Twój kod i co należy naprawić.

   / * Czy istnieje lepszy sposób na osiągnięcie tego? * / Płeć: input type = "radio" name = "płeć"? Php if (isset ($ płci) && $ gender == "kobieta") echo "checked" ; ?> value = "kobieta"> Kobieta typ wejścia = "radio" name = "płeć"? php if (isset ($ płeć) && $ płeć == "mężczyzna") echo "checked";?> value = "mężczyzna ” > Mężczyzna

4. 4 Zostaw komentarze, aby cofnąć określone bloki kodu. Jest to bardzo przydatne, gdy testujesz swój kod i chcesz zatrzymać jego działanie. Wszystko zawarte w znaku komentarza zostanie zignorowane po uruchomieniu strony.

   ?php echo "/ * Witaj * / Świat!"; / * Po uruchomieniu powyższego kodu słowo "Hello" nie zostanie odzwierciedlone * /?> Var13 ->

5. 5 Zachowaj ostrożność podczas komentowania dużych bloków kodu. Funkcja komentowania kończy się, gdy aktywny jest pierwszy znak zakończenia, więc jeśli w kodzie znajduje się wielowierszowy komentarz, który już skomentowałeś, będzie on trwał tylko do początku oryginalnego komentarza.

   ?php / * echo "Witaj świecie!"; / * Ten komentarz zrujnuje wszystko * / * /?> Var13 ->
   

   ?php / * echo "Witaj świecie!"; // Ten komentarz będzie w porządku * /?> Var13 ->

6. 6 Używaj komentarzy do tworzenia pseudonagrań. Możesz użyć niektórych formatów kodu kreatywnego, aby utworzyć wpis kodu bezpośrednio w nim. Jest to bardzo przydatne w przypadku projektów typu open source.

   ?php // ============= // NAGŁÓWEK // ============== // ------------ - // Podtytuł // ------------- / * Nazwa sekcji * / # Tutaj można wpisać wpisy # Tu można wpisać drugą część / * * Użyj tego do wyjaśnienia * po co ci kilka linijek * lub nawet kilka punktów wyjaśnienia * /?> var13 ->

Porady

• Komentarze HTML i PHP różnią się od siebie, więc podczas pracy ze skryptami (kombinacją HTML i PHP) upewnij się, że używasz prawidłowej składni.
• Na przykład poniższy kod zawiera komentarz HTML, ale nadal wykonuje kod PHP. Jeśli umieścisz komentarz HTML wewnątrz tagu PHP, spowoduje to błąd.
  • ! - div id = "przykład">? php echo 'hello'; ?> var13 -> / div> ->