PHP

註解

程式裡面很重要的其中一個角色是程式中的註解,它是對於這支程式的相關說明,說明的內容包括這支程式是誰寫的、何時寫的、程式的名稱以及執行的目的,還有其它對於每一個重要程式片的說明。註解的目的,除了讓後續維護這個程式的人員知道有什麼問題要找誰之外,適當的註解也可以讓別人和自己(沒錯,3個月之後你再回來看,也會看不懂某些程式指令當初為何要那麼寫)更容易瞭解這支程式的一些細節。

因為註解的重要性,因此幾乎所有的程式都有註解的相關符號。雖然大部份的時候PHP程式碼是和HTML程式碼混雜在一起的,但是它使用的註解符號卻和HTML所使用的不同。請直接參考下面這支程式的內容:

<?php
  // This is a comment line.
  # This is also a comment line.
  /*
    Here is a multiple-line comment block.
    comment line,
    and lines...
  */
  echo "Done!\n";  // This is the end of the program.
?>

如果註解的內容只有一行的話,可以使用「//」或是「#」,在程式的任一處只要出現了這兩個符號,它之後的所有字元都不會被PHP直譯器所處理,可以自由地書寫任意的文字。

有些時候註解的內容可能超過一行,你可以選擇在每一行的前面加上上述的兩個符號之一,也可以使用C語言標準的註解符號「/*」以及「*/」,凡是在這兩個符號之間的所有文字,也都會被PHP直譯器所忽略。

由於直譯器會忽略註解的內容不加以處理,因此註解的多少並不會影響到程式的執行效能,因此基於程式的可維護性,正式以及較大型的程式專案請務必加上詳細且適當的註解。

發表迴響

在下方填入你的資料或按右方圖示以社群網站登入:

WordPress.com 標誌

您的留言將使用 WordPress.com 帳號。 登出 /  變更 )

Google photo

您的留言將使用 Google 帳號。 登出 /  變更 )

Twitter picture

您的留言將使用 Twitter 帳號。 登出 /  變更 )

Facebook照片

您的留言將使用 Facebook 帳號。 登出 /  變更 )

連結到 %s