2012-04-03 42 views
1

有沒有辦法在自定義函數/類的工具提示中給文本編輯器提供摘要信息,以便在編碼時可以爲標準庫執行操作?是否有與C#摘要標籤相當的PHP?

失敗這是什麼是突出目的的標準方法,所需的參數等在PHP中的函數/類。

回答

2

結賬PHPDocumentor

一個例子是:

/** 
* Set the data 
* 
* @access public 
* @param string $field 
* @param mixed $value 
*/ 
public function __set($field, $value) 
{ 
    $this->_data[$field] = $value; 
} 

/** 
* Get the data 
* 
* @access public 
* @param string $field 
* @return mixed 
*/ 
public function __get($field) 
{ 
    return isset($this->_data[$field]) ? $this->_data[$field] : NULL; 
} 

由於意見自我解釋,你使用@access了該方法的可見性(如果被概括代碼當然是一個方法,),@param展示每個參數和@return顯示正在返回的數據的類型。有很多不同的標籤來記錄代碼的許多不同方面。

+0

並提及什麼編輯器支持PHPDoc將是很好的。 – CodeCaster 2012-04-03 12:11:16

+0

** @ CodeCaster:答案是:many **;) 引用自http://en.wikipedia.org/wiki/PHPDoc:_... Zend Studio,NetBeans,JetBrains PhpStorm,ActiveState Komodo Edit和IDE和Aptana Studio_正在使用PHPDoc來_解釋變量類型和其他歧義_ – SimonSimCity 2012-04-03 12:13:22

+0

這看起來正是我在找的東西 - 謝謝! – RichieAHB 2012-04-03 12:59:37

1

您可以使用PHPDoc標準讓您的IDE提供有關例如函數的提示。

只是一個函數聲明之前,你可以有:

/** 
* This is a DocBlock comment 
*/ 
function foo(){ 
    //.... 
} 

我在Netbeans中使用它,可以說,它的工作原理相當不錯。

相關問題