Korzystanie z komentarzy w PHP

Korzystanie z komentarzy w PHP
Komentarze są używane z dowolnym kodem źródłowym do prawidłowego wyjaśnienia funkcjonalności kodu. Każdy język programowania używa konkretnej składni, aby dodać komentarz w kodzie źródłowym. Komentarz nie jest czytany przez interpretera lub kompilatora języka programowania. Koder tak naprawdę nie musi dodawać komentarzy w kodzie, ale istnieją dwie zalety używania komentarza w kodzie. Jedną z korzyści jest uczynienie kodu, aby inni mogli prawidłowo zrozumieć kod, a kolejną korzyścią jest pomoc koderowi przypomnieć funkcjonalność kodu po długim czasie, gdy kod wymaga modyfikacji. Składnia komentarzy stosowana w PHP jest podobna do innych standardowych języków programowania, takich jak C, C ++, Java itp. Komentarz może być jednoganową i wieloma linią. W tym samouczku można użyć komentarzy jednokierunkowych i wielu linii w kodzie PHP.

Komentarz jednoliniowy

Komentarz jednoliniowy może być używany w kodzie PHP za pomocą innej składni. W tym samouczku pokazano dwa typy komentarza kodu PHP. Jednym z nich jest składnia komentarza C ++/Java, a druga składnia komentarza powłoki. Dwie składnia używania jednolodowych komentarzy w PHP pokazano w tym rozdziale samouczka.

Przykład-1: Komentarze z pojedynczą linią za pomocą składni C ++/Java

Znaki do podwójnego skrótu ('//') są używane do komentowania jednego wiersza w skrypcie PHP. W poniższym skrypcie do wyjaśnienia kodu używanych jest pięć komentarzy jednolodowych. Tutaj wartości trzech strun są zadeklarowane, a one są one później połączone w inną zmienną. Dla każdego oświadczenia, który jest pominięty przez tłumacza w momencie wykonania.

// Ustaw pierwszą wartość ciągu
$ str1 = „wita”;
// Ustaw drugą wartość ciągu
$ str2 = "to";
// Ustaw trzecią wartość ciągów
$ str3 = "Linuxhint";
// Połącz sznur z przestrzenią
$ str = $ str1.„”.$ str2.„”.$ str3;
// Wydrukuj połączony ciąg
Echo "

$ str

";
?>

Wyjście:

Następujące dane wyjściowe pojawią się po wykonaniu kodu. Wyjście pokazuje połączone wartości STR1, $ STR2 i $ STR3. Wszystkie komentarze jednoliniowe zostały zignorowane przez tłumacza.

Przykład-2: Komentarze jednoliniowe za pomocą składni powłoki

Symbol „#” jest używany do komentarza jednoliniowego w skrypcie powłoki, który jest obsługiwany przez PHP. Poniższy skrypt PHP oblicza, czy bieżący rok to rok skokowy, czy nie. Funkcja niestandardowa isLeap () jest tutaj używana do obliczenia, czy bieżący rok jest rokiem skokowym, czy nie. Komentarz jednoliniowy jest używany w kodzie, aby skrypt był bardziej czytelny dla czytelników. Tutaj funkcja DATE () jest używana do odczytania bieżącego roku wymienionego w komentarzu. Następnie funkcja mktime () służy do sprawdzenia, czy rok jest rokiem skokowym, czy nie. Jeśli rok jest rokiem, wówczas funkcja mktime () zwróci 1, a znak formatowy „l” jest używany w funkcji DATE (. W skrypcie używane są niezbędne komentarze jednokierunkowe.

#Przeczytaj bieżący rok od daty systemu
$ rok = data („y”);
#Zajmuj funkcję isLeap () i przetestuj wartość zwracaną
If (isLeap ($ rok))

Echo "

Rok, Rok $ to rok skokowy.

";

w przeciwnym razie

Echo "

Rok, Rok $ nie jest rokiem skokowym.

";

#Określ funkcję, aby sprawdzić rok skokowy
Funkcja IsLeap ($ rok)

#Znajdź rok jest skokny lub nie
return (data („l”, mktime (0, 0, 0, 1, 1, $ rok)) == 1);

?>

Wyjście:

Następujące dane wyjściowe pojawią się po wykonaniu kodu. Wyjście pokazuje, że bieżący rok, 2020, to rok skokowy, a wszystkie komentarze jednokierunkowe zostały zignorowane przez tłumacza.

Komentarz wieloliniowy

Do dodania długiego komentarza tekstu służy do dodania długiego komentarza. Jeśli koder musi szczegółowo wyjaśnić funkcję kodu w celu lepszego zrozumienia, może on/ona może dodać komentarz wieloletniego dla tego kodu. „/*” Jest używany na początku komentarza, a „*/” jest używany na zakończeniu komentarza. Ten typ komentarza wieloletniego jest używany w dowolnym standardowym języku programowania, takim jak Java, C ++ itp. Komentarz wieloletnie jest używany głównie na początku dowolnego skryptu do podania szczegółowych informacji o skrypcie, scenariuszu, wersji, linku kodu źródłowego itp.
Jak wykorzystywane są komentarze wieloletnie w PHP, pokazano w poniższym przykładzie:

Przykład-3: Komentarz wielokierunkowy za pomocą „/ *… */”

W poniższym skrypcie do wyjaśnienia kodu używane są trzy komentarze wieloletnie. Pierwszy komentarz opisuje funkcjonalność skryptu. Drugi komentarz wyjaśnia funkcję funkcji rand (). Trzeci komentarz wyjaśnia cel funkcji ISPRIME (). Losowa liczba od 1 do 100 będzie generowana za każdym razem, gdy skrypt będzie wykonywany, a funkcja ISPRIME () dowie się, czy liczba jest pierwsza, czy nie. Jeśli funkcja zwraca true, wówczas liczba jest pierwsza. W przeciwnym razie liczba nie jest pierwsza.

/* Poniższy skrypt przetestuje określony numer
Prime lub nie, używając niestandardowej funkcji
*/
/* Przypisz liczbę losową od 1 do 100, używając
wbudowana funkcja php rand ()
*/
$ liczba = rand (1100);
// Sprawdź liczbę jest pierwotna lub nie prime
if (isprime ($ liczba))
Echo "

Liczba $ to liczba pierwsza.

";
w przeciwnym razie
Echo "

Liczba $ nie jest liczbą pierwszą.

";
/* Funkcja zwróci 1, jeśli wygenerowana liczba losowa
liczba losowa jest pierwsza i zwraca 0, jeśli liczba nie jest
główny */
funkcja isprime ($ numer)
if ($ liczba == 1)
powrót 0;
dla ($ i = 2; $ i

Wyjście:

Wyjście skryptu będzie się różnić w każdym wykonaniu z powodu liczby losowej. Następujące dane wyjściowe pojawiło się po wykonaniu kodu po raz pierwszy i zostanie zmienione w następnym wykonaniu. Jeśli wygenerowana liczba losowa jest pierwsza, wówczas isprime () zwróci 1, a jeśli wygenerowana liczba losowa nie jest pierwsza, wówczas isprime () zwróci 0.

Wniosek

Każdy standardowy skrypt zawiera komentarze, aby pomóc czytelnikowi poprawnie zrozumieć kod. Wielu nowych programistów nie dodaje komentarzy do swojego skryptu, co sprawia, że ​​kod jest trudny do zrozumienia dla innych koderów. Tak więc, pisząc dowolny skrypt, powinieneś dodać komentarze dla każdego oświadczenia.