Jak tworzyć komentarze na temat PHP: 3 kroki

Komentarz jest typem uwagi, który można użyć do wyjaśnienia celu i wartości fragmentu kodu. Praca w PHP, będziesz miał kilka opcji do pisania komentarzy, które poszły ze starych dobrze znanych języków programowania: wchodząc do komentarzy jednolitych lub wielokresji. Możesz użyć komentarzy, aby nie dać fragmentu kodu do zarabiania lub tylko do nagrywania rekordów.

Kroki

Część 1 z 2:

Style

jeden. Komentarze jednorazowe dla krótkich rekordów. Jeśli chcesz zostawić krótki komentarz, użyj kodu komentarza jednolitych. Komentarz dyktuje tylko do końca linii lub końca bloku kodu. Takie komentarze działają tylko wewnątrz znaczników PHP i zostaną odczytane tylko wtedy, gdy umieścisz je w HTML.

// Jest to sposób standardowy (C ++), aby utworzyć komentarz jednolity. Aby utworzyć komentarz jednorazowy. Możesz także użyć tego stylu UNIX ?>

2. Aby napisać długie komentarze lub kod testowy, użyj komentarzy wielointerii. Komentarze wielokresowe są bardzo przydatne podczas pisania długich wyjaśnień i zapobieganie przetwarzaniu segmentu kodu. Przeczytaj sekcję "Użyj", aby dowiedzieć się o niektórych wskazówkach dotyczących użycia "komentarzy wielointerii.

/ * W ten sposób jest wart formatowy komentarz. Cały podręcznik na końcu etykiety będzie zawierał komentarz * // * niektórzy lubią włączyć * na górę każdej linii * dodatkowe markery. Poprawi * czytelność dużych komentarzy, chociaż nie jest to obowiązkowe. * /?>

Część 2 z 2:

Za pomocą

jeden. Użyj komentarzy do pozostawienia notatek do wydajności kodu. Nie musisz tego robić dla każdego wiersza kodu, ponieważ inni programiści mogą łatwo dowiedzieć się w dobrze napisanym kodzie. Komentarze są przydatne, jeśli kod wykonuje niestandardowe lub nie oczywiste funkcje.

// Utwórz żądanie Curl $ Session = Curl_init ($ prośba) - // powiedz Curl, aby użyć HTTP Postcurl_setopt ($ session, curlopt_post, true)-

2. Zostaw komentarze, aby nie zapomnieć, co zrobiłeś z kodem. Podczas pracy na projekcie komentarze nie pozwolą ci zapomnieć, co się zatrzymałeś. Zostaw komentarze do kodu, który działa nieprawidłowo lub jeszcze nie skończyłeś.

// Przed kontynuowaniem do następnego kroku musisz dwukrotnie sprawdzić wynik tego programu "Witaj świecie!"-

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

/ * Czy jest bardziej skuteczny sposób?* / Płeć: Jeśli (Isset ($ Płeć) && $ Gender =="Płeć żeńska") Echo "Sprawdzone"-?> Wartość ="Płeć żeńska"> Kobieta Jeśli (Isset ($ Płeć) && $ Gender =="Męski") Echo "Sprawdzone"-?> Wartość ="Męski"> Mężczyzna

cztery. Zostaw komentarze do anulowania konkretnych bloków kodu. Jest dość przydatne, gdy testujesz kod i chcesz zatrzymać pracę jakiegoś fragmentu. Podczas uruchamiania strony wszystko, co jest zawarte w etykiecie komentarza zostaną zignorowane.

Echo "/ * Witaj świecie!"-/ * Podczas uruchamiania wyżej wymienionego kodu słowo "Hello" nie jest odzwierciedlone * /?>

pięć. Uważaj, aby komentował duże bloki kodu. Funkcja komentowania zakończy się po zakończeniu pierwszego znaku ukończenia, więc jeśli wewnątrz kodu, który już skomentowałeś, jest komentarzem wieloinformowany, okazuje się tylko przed początkowym komentarzem.

/ * ECHO "Witaj świecie!"- / * Ten komentarz będzie zepsuć * / * /?>

/ * ECHO "Witaj świecie!"- // z tym komentarzem wszystko będzie dobrze * /?>

6. Użyj komentarzy do utworzenia pseudo-rejestratora. Możesz użyć niektórych formatów kodów kreatywnych, aby utworzyć rekordowy kod bezpośrednio w niej. Jest dość przydatne dla publicznie dostępnych projektów.

// ============= // Tytuł // ============= // ------------- /// Subtitle // ------------- / * Nazwa sekcji * / # Records Możesz tutaj pisać # Druga część może być zapisywana tutaj / * * Skorzystaj z tego do wyjaśnienia: dla którego potrzebujesz kilka linii * lub nawet kilka punktów objaśnienia * /?>

Rada

Komentarze HTML i PHP różnią się od siebie, więc podczas pracy ze scenariuszami (kombinacja HTML i PHP) upewnij się, że używasz poprawnej składni.
Na przykład w następnym kodzie znajduje się komentarz HTML, ale nadal występuje kod PHP. Jeśli umieścisz komentarz HTML w tagu PHP, to spowoduje.