1. 程式人生 > >如何寫PHP規範註釋

如何寫PHP規範註釋

轉載自:http://hi.baidu.com/leo5210/item/291877ea5f125c345b7cfb83

所有的文件標記都是在每一行的 * 後面以@開頭。如果在一段話的中間出來@的標記,這個標記將會被當做普通內容而被忽略掉。
@access        該標記用於指明關鍵字的存取許可權:private、public或proteced 使用範圍:class,function,var,define,module
@author        指明作者
@copyright    指明版權資訊
@const        使用範圍:define 用來指明php中define的常量
@final            使用範圍:class,function,var 指明關鍵字是一個最終的類、方法、屬性,禁止派生、修改。
@global        指明在此函式中引用的全域性變數
@name            為關鍵字指定一個別名。
@package    用於邏輯上將一個或幾個關鍵字分到一組。
@abstrcut    說明當前類是一個抽象類
@param        指明一個函式的引數
@return        指明一個方法或函式的返回值
@static            指明關建字是靜態的。
@var            指明變數型別
@version        指明版本資訊
@todo            指明應該改進或沒有實現的地方
@link            可以通過link指到文件中的任何一個關鍵字
@ingore        用於在文件中忽略指定的關鍵字

一些註釋規範
a.註釋必須是
/**
* XXXXXXX
*/
的形式
b.對於引用了全域性變數的函式,必須使用glboal標記。
c.對於變數,必須用var標記其型別(int,string,bool…)
d.函式必須通過param和return標記指明其引數和返回值
e.對於出現兩次或兩次以上的關鍵字,要通過ingore忽略掉多餘的,只保留一個即可
f.呼叫了其他函式或類的地方,要使用link或其他標記連結到相應的部分,便於文件的閱讀。
g.必要的地方使用非文件性註釋(PHPDOC無法識別的關鍵字前的註釋),提高程式碼易讀性。
h.描述性內容儘量簡明扼要,儘可能使用短語而非句子。
i.全域性變數,靜態變數和常量必須用相應標記說明

能夠被phpdoc識別的關鍵字:
Include
Require
include_once
require_once
define
function
global
class

規範註釋的php程式碼 :

  1. <?php  
  2. /** 
  3. * 檔名(sample2.php) 
  4. * 功能描述(略) 
  5. * @author steve <[email protected]
  6. * @version 1.0 
  7. * @package sample2 
  8. */  
  9. /** 
  10. * 包含檔案 
  11. */  
  12. include_once 'sample3.php';  
  13. /** 
  14. * 宣告全域性變數 
  15. * @global integer $GLOBALS['_myvar'] 
  16. * @name $_myvar 
  17. */  
  18. $GLOBALS['_myvar'] = 6;  
  19. /** 
  20. * 宣告全域性常量 
  21. */  
  22. define('NUM', 6);  
  23. /** 
  24. * 類名 
  25. * 類功能描述 
  26. * @package sample2 
  27. * @subpackage classes(如果是父類 就新增) 
  28. */  
  29. class myclass {  
  30. /** 
  31. * 宣告普通變數 
  32. * @accessprivate 
  33. * @var integer|string 
  34. */  
  35. var $firstvar = 6;  
  36. /** 
  37. * 建立建構函式 {@link $firstvar} 
  38. */  
  39. function myclass() {  
  40. $this->firstvar = 7;  
  41. }  
  42. /** 
  43. * 定義函式 
  44. * 函式功能描述 
  45. * @global string $_myvar 
  46. * @staticvar integer $staticvar 
  47. * @param string $param1 
  48. * @param string $param2 
  49. * @return integer|string 
  50. */  
  51. function firstFunc($param1, $param2 = 'optional') {  
  52. static $staticvar = 7;  
  53. global $_myvar;  
  54. return $staticvar;  
  55. }  
  56. }  
  57. ?>  

相關推薦

如何PHP規範註釋

轉載自:http://hi.baidu.com/leo5210/item/291877ea5f125c345b7cfb83 所有的文件標記都是在每一行的 * 後面以@開頭。如果在一段話的中間出來@的標記,這個標記將會被當做普通內容而被忽略掉。 @access      

PHP程式碼註釋規範

PHPDocumentor是一個用PHP寫的工具,對於有規範註釋的php程式,它能夠快速生成具有相互參照,索引等功能的API文件。老的版本是 phpdoc。 1. 什麼是phpDocumentor ? PHPDocumentor 是一個用PHP寫的工具,對於有規範註釋的php程式,它能

PHP Document 註釋標記及規範 && PHP命名規範

註釋標記 @access 使用範圍:class,function,var,define,module 該標記用於指明關鍵字的存取許可權:private、public或proteced @author 指明作者 @copyright 使用範圍:class,function,var,

JAVA編程規範-註釋規範

應用 進行 ava line 而不是 信息 font 意義 控制 1.【強制】類、類屬性、類方法的註釋必須使用 Javadoc規範,使用/**內容*/格式,不得使用//xxx方式。說明:在 IDE編輯窗口中,Javadoc方式會提示相關註釋,生成 Javadoc可以正確輸出

php註釋、變量、類型、常量、運算符、比較符、條件語句;

小數 array cas 單引號 標識 php 規則 tro 特殊 php的註釋 1.// 2.# 3./* */ 變量 變量是儲存信息的容器; 變量規則: 1.變量以$開頭,後面跟名稱》》》$sum; 2.變量必須以字母或下滑先開頭,不能用數字開頭; 3.變量名稱對大小

從HTML中分離PHP, 在HTML種PHP代碼

解析 是否 other 使用方式 while 移植 splay 配置 可移植性 既有PHP代碼又有HTML代碼的文件必須以" .php "結尾. 為了使php解釋器忽略HTML代碼, php只處理一對PHP開始和結束標記之間的內容. 如: <p>This is

使用vs codephp及調試

用戶 als code vsc gpo file span ace trace 1.下載vscode (visual studio code)。 2.安裝vscode 擴展 php-debug 安裝步驟見 https://marketplace.visualstudio.c

PHP規範PSR16(快取庫的通用介面)事例

1 介面 快取介面定義了一組快取條目的最基本操作,這需要基本讀取,寫入和刪除單個快取項。 此外,它還具有處理多組快取條目的方法,例如一次寫入,讀取或刪除多個快取條目。當您要執行大量快取記憶體讀/寫操作時,這非常有用,並且允許您在對快取伺服器的單次呼叫中執行操作,從而顯著縮短延遲時間。 C

PHP規範PSR18(HTTP客戶端)介紹

本文件描述了用於傳送HTTP請求和接收HTTP響應的通用介面。 本文件中的關鍵詞“必須”,“必須”,“必需”,“應該”,“不應該”,“應該”,“不應該”,“推薦”,“可以”和“可選”按照RFC 2119中的描述進行解釋。 1 目標 此PSR的目標是允許開發人員建立與HTTP客戶端實現分離的庫

PHP規範PSR16(快取庫的通用介面)介紹

本文件描述了快取項和快取驅動程式的簡單但可擴充套件的介面。 本文件中的關鍵詞“必須”,“必須”,“必需”,“應該”,“不應該”,“應該”,“不應該”,“推薦”,“可以”和“可選”按照RFC 2119中的描述進行解釋。 最終的實現可以使用比提出的功能更多的功能來裝飾物件,但是它們必須首先實現所

PHP規範PSR15(HTTP伺服器請求處理程式)介紹

本文件描述了HTTP伺服器請求處理程式(“請求處理程式”)和HTTP伺服器中介軟體元件(“中介軟體”)的常用介面,這些介面使用PSR-7或後續替換PSR所描述的HTTP訊息。 HTTP請求處理程式是任何Web應用程式的基本組成部分。伺服器端程式碼接收請求訊息,對其進行處理並生成響應訊息。 HTTP中

PHP規範PSR13(超連結定義)事例

3. Interfaces 3.1 Psr\Link\LinkInterface <?php namespace Psr\Link; /** * A readable link object. */ interface LinkInterface { /**

PHP規範PSR13(連結定義介面)介紹

在HTML上下文和各種API格式上下文中,超媒體連結正變得越來越重要。但是,沒有單一的常見超媒體格式,也沒有一種通用的方式來表示格式之間的連結。 該規範旨在為PHP開發人員提供一種簡單,通用的方式來表示超媒體連結,而不依賴於所使用的序列化格式。這反過來允許系統將具有超媒體連結的響應序列化為一種或多種

PHP規範PSR11(依賴注入容器介面)介紹

本文件描述了依賴注入容器的通用介面。 ContainerInterface設定的目標是標準化框架和庫如何使用容器來獲取物件和引數(在本文件的其餘部分中稱為條目)。 本文件中的關鍵詞“必須”,“必須”,“必需”,“應該”,“不應該”,“應該”,“不應該”,“推薦”,“可以”和“可選”按照RFC

PHP規範PSR7(HTTP訊息介面)事例

3. Interfaces 3.1 Psr\Http\Message\MessageInterface <?php namespace Psr\Http\Message; /** * HTTP messages consist of requests from a client t

PHP規範PSR7(HTTP訊息介面)介紹(三)

1.5 服務端請求 RequestInterface提供HTTP請求訊息的一般表示。但是,由於伺服器端環境的性質,伺服器端請求需要額外的處理。伺服器端處理需要考慮通用閘道器介面(CGI),更具體地說,需要考慮PHP通過其伺服器API(SAPI)對CGI的抽象和擴充套件。 PHP通過超級全域性提供

PHP規範PSR7(HTTP訊息介面)介紹(二)

1.3 流 HTTP訊息由起始行,標題和正文組成。 HTTP訊息的主體可能非常小或非常大。嘗試將訊息正文表示為字串很容易消耗比預期更多的記憶體,因為正文必須完全儲存在記憶體中。嘗試將請求或響應的主體儲存在記憶體中將阻止使用該實現能夠使用大型訊息體。 StreamInterface用於在讀取或寫入

PHP規範PSR7(HTTP訊息介面)介紹(一)

本文件描述了RFC 7230和RFC 7231中描述的用於表示HTTP訊息的公共介面,以及RFC 3986中描述的用於HTTP訊息的URI。 HTTP訊息是Web開發的基礎。 Web瀏覽器和HTTP客戶端(如cURL)建立傳送到Web伺服器的HTTP請求訊息,Web伺服器提供HTTP響應訊息。伺服器

PHP規範PSR6(Cache介面)介紹

快取是提高任何專案效能的常用方法,使快取庫成為許多框架和庫的最常見功能之一。這導致許多庫推出自己的快取庫,具有各種級別的功能。這些差異導致開發人員必須學習多個系統,這些系統可能會也可能不會提供他們所需的功能。此外,快取庫本身的開發人員面臨著只支援有限數量的框架或建立大量介面卡類的選擇。 快取系統的通

PHP規範PSR-4的示例實現

以下示例說明了符合PSR-4的程式碼: 1 閉合事例 <?php /** * An example of a project-specific implementation. * * After registering this autoload function with SP