良好的文件注釋不但能使**易於維護，而且可以通過phpdocumentor等文件生成工具生成專案手冊，以便於查閱。此外php的弱型別特徵更應該引起我們對文件注釋的重視！
本文簡單的介紹下phpdoc文件注釋，以及常用的一些標籤。
1. 文件注釋並不只是用來注釋整個檔案的，在元素前面宣告之後，它可以和該特定的程式元素相關聯，例如類、函式、常量、變數、方法等等，以/**開頭、*/結束，注意注釋與相關聯的程式元素間不能有空行；
2. 常用的標籤
@author author name **編寫人(負責人)
@version xx.xx 當前版本號
@param datatype $v_name[,...] description 函式相關聯的引數，含有,...表示可傳入不定數量的其他引數
@return datatype description 函式或方法的返回值型別
@global datatype description 全域性變數的說明(僅對phpdocumentor解析器起作用)
@var datatype 在類中說明類變數(屬性)的型別
@example [path|url] description 舉乙個例子，以闡釋使用方法
@todo description 待完成的工作資訊或待解決的問題資訊
這裡舉乙個zend framework裡的一段**為例：
Swift 文件注釋規範
的結構和組織關乎了開發童鞋們的節操問題。明確和一致的 表示了明確和一貫的思想。編譯器並沒有乙個挑剔的口味，但當談到命名，空格或文件，人類的差異就體現出來了。nshipster 的讀者無疑會記得去年發表的關於文件的文章，但很多東西已經在 xcode 6 中發生了變化 幸運的是，基本上算是變得更好了 因...
PHP注釋規範
php注釋規範 注釋在寫 的過程中非常重要，好的注釋能讓你的 讀起來更輕鬆，在寫 的時候一定要注意注釋的規範。php裡面常見的幾種注釋方式 1.檔案的注釋，介紹檔名，功能以及作者版本號等資訊 檔名簡單介紹 檔案功能 author 作者 version 版本號 date 2020 02 02 2.類的...
php 注釋規範
注釋在寫 的過程中非常重要，好的注釋能讓你的 讀起來更輕鬆，在寫 的時候一定要注意注釋的規範。在以後的 中加上注釋，養成良好的習慣。尤其是在為客戶做專案的時候，一定要加上。php裡面常見的幾種注釋方式 1.檔案頭的注釋，介紹檔名，功能以及作者版本號等資訊 檔名簡單介紹 檔案功能。author alv...