PHP 中的註釋

王林
發布: 2024-08-29 12:34:10
原創
1026 人瀏覽過

評論這個字本身表達的意思是註解掉某些東西。如果我們在 PHP 程式檔案中註解任何內容,它不會與程式碼一起編譯。編譯器或解釋器將簡單地忽略這一點。我們可以透過多種方式對 PHP 程式語言中的任何內容進行註解。 PHP 也有單行和多行註解選項。另外,在單行註解中,我們可以根據需要使用 / 或 #。我們應該始終在註釋中編寫適當的語言,以便任何正在審查該程式碼的人都可以閱讀並理解該註釋。

開始您的免費軟體開發課程

網頁開發、程式語言、軟體測試及其他

文法

同樣,我們可以在 PHP 中透過以下方式使用註解。

單行註解:

// This is a single-line comment
# This is a single-line comment
/*
This is a multiple line comment – line no – 1
This is a multiple line comment – line no – 2
… and so on …
*/
# this is the single-line comment
; this is a PHP.INI style commenting
登入後複製

PHP 中的註解是如何運作的?

當我們在程式碼中寫入註解時,與實際程式碼相比,它看起來會更輕。如果我們將程式碼和註解寫在同一個檔案中,在這種情況下,在運行該 PHP 檔案時註解將不會被執行。讓我們透過一個例子來看看。

<?PHP
echo "This is my first PHP Program";
// this is the first program
?>
登入後複製

這只會給出「這是我的第一個 PHP 程式」作為輸出,而不是註解部分。

為什麼我們應該使用註解?

我們應該在 PHP 程式碼之間使用註釋,以確保我們有足夠的幫助註釋,以便人們可以輕鬆閱讀和理解程式碼。在註解中,我們也可以出於編寫程式碼段的目的,更改日期、修改日期、修改者等。強烈建議開發人員在程式碼中使用註釋,以便能夠理解事情每當需要時,只需很少的努力或根本不需要努力即可輕鬆完成。

範例

現在,是時候看一些快速範例來檢查程式中評論的行為了。

範例#1
<?php
echo "This is my first PHP Program";
// this is the first program
?>
登入後複製

輸出

PHP 中的註釋

範例#2

程式中的單行註解

代碼:

<?php
echo date_default_timezone_get(); //to get the timezone
echo "<br>"; //line brea;
date_default_timezone_set('Asia/Kolkata'); // setting the timezone to Asia/Kolkata
echo date_default_timezone_get(); //to get the timezone
?>
登入後複製

輸出

PHP 中的註釋

範例#3

程式中多行註解

代碼:

<?php
/*
This is a function that will take time in minutes and will return that in hours and minutes
We use will this function further to test with some examples.
*/
function hoursandmins($minutes, $format = '%01d Hours, %02d Minutes')
{
if ($minutes < 1) {
return;
}else if($minutes<10){
if($minutes==1){
return '0'.$minutes.' Minute';
}
return '0'.$minutes.' Minutes';
}else if($minutes<50){
return $minutes.' Minutes';
}
$hours = floor($minutes / 60);
$minutes = ($minutes % 60);
$format = "";
if($hours>0){
if($hours>1){
$format .= '%01d Hours';
}else{
$format .= '%01d Hour';
}
}
if($hours>0 && $minutes>0){
$format .= ', ';
}
if($minutes>0){
if($minutes>1){
$format .= ' %02d Minutes';
}else{
$format .= ' %01d Minute';
}
}
return sprintf($format, $hours, $minutes);
}
// time to check the time in descriptive form
echo hoursandmins(20);
echo "<br>";
echo hoursandmins(120);
?>
登入後複製

輸出

PHP 中的註釋

在任何函數之前編寫的有關該函數的任何註釋通常稱為函數文件。因此,在給定的場景中,我們可以將此註釋視為功能文件。使用這樣的評論真是太好了。為了讓 PHP 程式更加健壯,我們有各種 PHP 標準,規定我們不應在函數內使用註釋,因為我們可以在函數文件中執行相同的操作。

範例#4

褒貶不一的評論

在 PHP 程式檔案中,我們可以將 PHP 和 HTML 結合起來。考慮到這一點,我們將在需要時使用HTML註解方法將HTML部分註解掉,而PHP註解可以根據業務需求用於PHP相關程式碼。我們可以在 PHP-HTML 檔案中使用任何類型的 PHP 註解和 HTML 註解。

代碼:

<html>
<body>
<h1>PHP with HTML</h1>
<!-- this is html comment -->
<?php
echo "Hello World!"; // this is PHP comment
?>
</body>
</html>
登入後複製

輸出

PHP 中的註釋

範例#5

使用#的單行註解

我們也可以使用 # 來使用單行註解。讓我們看一個相同的程式碼範例。我們可以看到,這條評論並沒有那麼受歡迎。很少有開發人員使用此類註釋。在註釋函數文件或文件級文件時確實建議這樣做。

代碼:

<?php
# $i=10;
# $j=20;
# echo $i + $j;
echo "Hello World!";
# this is PHP comment
?>
登入後複製

輸出

PHP 中的註釋

結論

註解其實是程式碼中的時間呼叫。我們可以在 PHP 程式檔案中使用註解。這將幫助我們使程式碼更容易理解。我們應該在開始函數或類別之前使用註釋,因為大多數程式語言都有自己的程式碼標準。通常,任何函數或類別之前的註解稱為該函數或類別的文檔。

以上是PHP 中的註釋的詳細內容。更多資訊請關注PHP中文網其他相關文章!

相關標籤:
php
來源:php
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板
關於我們 免責聲明 Sitemap
PHP中文網:公益線上PHP培訓,幫助PHP學習者快速成長!