PHP 註釋
- PHPz原創
- 2024-08-29 13:02:09580瀏覽
PHP 註解基本上是元數據，可以包含在原始程式碼中，也可以包含在類別、函數、屬性和方法之間。無論在何處聲明它們，它們都以前綴 @ 開頭，並且它們指示特定的內容。他們提供的這些資訊對編碼人員非常有用，有助於文件目的，IDE 也可以使用它來顯示某些彈出提示之類的東西。除了驗證之外，相同的註釋還可以用於其他目的，例如確定需要在表單中給出哪種輸入以及用於自動化目的。有各種類型的註釋，例如 @var 和 @int 類型，正如其名稱本身所暗示的那樣，它們可用於特定用途。
廣告 該類別中的熱門課程 PHP 開發人員 - 專業化 | 8 門課程系列 | 3次模擬測驗開始您的免費軟體開發課程
網頁開發、程式語言、軟體測試及其他
文法
PHP註解是透過@前綴來使用的，其語法如下：
class Example
{
// @var integer
public $new;
}
這裡的註解是@var，每當在任何程式碼片段之前遇到它時（例如這裡的public $new），它表明$new將具有註解所告訴的整數類型的值。
class Example
{
// @var integer
// @range(0, 51)
// @label('Count of shops')
public $shop;
}
註解也可以用來指定顯示函數整數值的最大值和最小值的範圍，並且標籤給出了該函數的用途。
PHP 註記的種類
以下給出了類型：
1.內建註解
註解中有2個內建函數，如下：
a。 Compiled: 此註解指示該方法/函數是否應該進行 JIT 編譯。它也是函數範圍類型的註解。
b。 SuppressWarnings：這是另一個內建註釋，這意味著必須抑制在執行其下面的後續程式碼時引發的任何警告。
2.元註解
這些是可用於申請其他註釋的註釋類型。它們用於配置註釋。
a。 @註釋
有一種註解類別將包含@annotation。
代碼：
[@Annotation]
class MyAnnoExample {
// piece of code
}
b。 @目標
顧名思義，此註解表示該註解適用的類別元素類型或方法。
據此我們可以描述一個或多個目標：
- 屬性註解位於屬性類別宣告之前。
- 在聲明類別之前允許的類別。
- 函數在函數宣告之前宣告。
- 方法註解允許繼續進行方法宣告。
- 允許使用註解來繼續聲明註解類別。
c. @可重複
這個註解意味著它在使用時可以重複任意次數。
d。 @繼承
這也可以作為元註解用於其他使用者定義的註解類別。這些繼承的註解在超類別上使用時會自動繼承到各自的子類別。
3.自訂註解
這些與普通類別的聲明非常相似。註釋類型的每個元素都由每個屬性聲明定義。
PHP 註解範例
下面給出了提到的範例：
範例#1
代碼：
// namespace declaration here
[@Annotation]
[@Target("class")]
class MyAnnoEx {
[@Required]
public string $prop;
public array $arrayProp = [];
public embedAnno $embed;
}
[@Annotation]
// code for embedded annotation goes here
[@Target(["class", "annotation"])]
class embedAnno {
}
[@Annotation]
// example for target annotation
[@Target("property")]
class propAnno {
}
@Annotation
// code for method annotation goes here
@Target("method")
class methodAnno {
public string $val;
public function __construct(string $val) {
$this->val = $val;
}
}
這只是一個基本範例，顯示了上面顯示的所有不同類型註解的用法。範例中的嵌入註解、屬性註解、方法註解等都是自訂註解。
範例#2
代碼：
<!DOCTYPE html>
<html>
<body>
<?php
/**
* @Replace("exmaple", "for", "annotation")
*/
class MyNamedComponent
{
}
echo str_replace("First", "Second", "First Example");
?>
</body>
</html>
輸出:
在這個例子中，我們將註解命名為replace，因為下面的程式碼代表了字串替換函數的用法，即str_replace，PHP的內建函數。使用此函數，函數中傳遞的第一個參數將被第二個參數取代。
範例 #3
代碼：
<!DOCTYPE html>
<html>
<head>
<title>Simple Form Processing</title>
</head>
<body>
<h1>Form Processing using PHP</h1>
<fieldset>
<form id="formex1" method="post" action="formexample.php">
<!--Declaring First name for the form
@Annotation text first_name-->
First_Name:
<input type="text" name="First_Name"/>
<!--@var style color-->
<span style="color:blue;">*</span>
<br>
<br>
<!--Declaring Last_Name for the form
@Annotation text last_name-->
Last_Name:
<input type="text" name="last_name"/>
<span style="color:blue;">*</span>
<br>
<br>
<!--Declaring Location for the form
@Annotation text location-->
Stay location:
<input type="text" name="location"/>
<span style="color:blue;">*</span>
<br>
<br>
<!--Declaring EMAILID for the form
@Annotation text email-->
EmailID:
<input type="email" name="emailID"/>
<span style="color:blue;">*</span>
<br>
<br>
<!--Declaring Password for the form
@Annotation password-->
Password:
<input type="password" name="password"/>
<span style="color:blue;">*</span>
<br>
<br>
<!--Declaring Password for the form
@Radio button password-->
Gender:
<!-- Gender to be selected as either male or female -->
<input type="radio"
value="Male"
name="gender"> Male
<input type="radio"
value="Female"
name="gender">Female
<br>
<br>
<input type="confirm" value="confirm" name="confirm" />
</form>
</fieldset>
<?php
if(example($_POST['confirm']))
{
if(!example($error))
{
echo"<h1>DETAILS RECEIVED</h1><br>";
echo "<table border='2'>";
echo "<thead>";
echo "<th>Argument</th>";
echo "<th>Value</th>";
echo "</thead>";
echo "<tr>";
echo "<td>First Name</td>";
echo "<td>".$First_Name."</td>";
echo "</tr>";
echo "<tr>";
echo "<td>Last_Name</td>";
echo "<td>".$last_name."</td>";
echo "</tr>";
echo "<tr>";
echo "<td>Stay location</td>";
echo "<td>".$location."</td>";
echo "</tr>";
echo "<tr>";
echo "<td>Email Stay location</td>";
echo "<td>" .$emailID."</td>";
echo "</tr>";
echo "<tr>";
echo "<td>Password</td>";
echo "<td>".$password."</td>";
echo "</tr>";
echo "<tr>";
echo "<td>Gender</td>";
echo "<td>".$gender."</td>";
echo "</tr>";
echo "</table>";
}
}
?>
</body>
</html>
輸出：
在此範例中，我們結合 PHP 中的表單驗證來展示註解。使用註釋，我們標記了作為表單輸入參數所需的所有參數，例如名字和姓氏、電子郵件、位置和密碼。
結論
透過上面的範例，我們注意到註解是如何成為使用和表達有關我們的方法、類別或屬性的元資料的強大工具。我們還了解如何組合不同類型的註釋來透過編寫有關工作人員的一些元資料來聲明將執行某些任務的工作人員。這使得它們很容易找到，並提供有關它們是否可以使用的實際資訊。
以上是PHP 註釋的詳細內容。更多資訊請關注PHP中文網其他相關文章！