2012-08-08 48 views
3

是什麼/ **的在PHP 例子的意思什麼是/ **在PHP中?

/** 
    * Method to display a view. 
    * 
    * @param boolean   If true, the view output will be cached 
    * @param array   An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. 
    * 
    * @return JController  This object to support chaining. 
    * @since 1.5 
    */ 

我似乎不能搜索呢?什麼是關鍵字用於我能夠搜索它?它會進入代碼還是隻是一個評論?

+3

9個答案,呃?你們正在排隊等待撲救。 – rdlowrey 2012-08-08 04:39:30

回答

3

/*開始評論。在此之後的任何其他內容,直到第一個*/是評論的一部分,因此/**中的第二個*沒有什麼特別 - 只是評論的一部分。一些在線文檔/代碼註釋系統可能會發現它很重要,但對於PHP來說,這意味着什麼都沒有。

0

/*是一個多行註釋標記。這是開始標記,*/是結束標記。

1

它只是用來評論一段代碼。這裏有一個例子:

/* here is a block of code 
And some more 
And some more */ 

您也可以發表評論單一線,//這樣的:

//this is a comment 
0

/* content goes here */是用於PHP註釋文本出來。

您還可以使用:

//content goes here將comemnt對具體線路

1

這是一個doxygen的註釋的開始一切。見http://www.stack.nl/~dimitri/doxygen/index.html。 Doxygen通過特殊格式的評論創建文檔。 @param和@returns是doxygen識別的標記。作爲創建許多語言和輸出風格的程序員文檔的一種方式,Doxygen幾乎是一個行業標準。它掃描源文件,收集編碼人留下的註釋信息,然後以各種格式創建文檔,如HTML,Latex等。

2

/*開始多行註釋,用*/

/**是專門爲PHPDoc的,可能還有一些其他的PHP文件生成軟件結束。您必須使用/**來獲取該軟件的評論並從中創建文檔。 /*只會做不到。

0

這是一個評論的開始,它將被Doxygen等文檔生成器轉化爲功能性文檔。 「/ *」部分開始以「* /」結尾的普通PHP註釋,額外的星號將註釋標記爲用於外部處理的元數據。

+0

有趣 - 我很確定我在寫這些時輸入了星號。我想知道他們去了哪裏!我會解決它。 – 2012-08-08 09:19:44

+0

顯然星號必須用「\」來轉義或者不顯示。 – 2012-08-08 17:10:24

1

多次提到的/**是PHP註釋塊的開始。您可以在PHP manual中閱讀更多關於PHP評論的內容。

註釋塊中的信息用於描述下面的方法。 Joomla使用PHPDoc自動構建文檔頁面,使用@param@return等標籤。你可以在this page上閱讀更多關於Joomla的文檔標準。

+0

現在Joomla筆記已經從原始文章中移除了Joomla標籤 – 2012-08-08 04:32:15

5

這叫做DocBlock樣式註釋。一般來說,代碼應該被大量地評論。它不僅有助於描述缺乏經驗的程序員的代碼的流程和意圖,而且可以在數月後返回自己的代碼時證明是非常寶貴的。這不是評論所需的格式,但推薦使用。

DocBlock風格註釋前述類和方法聲明,這樣他們可以通過IDE的被拾起:

/** 
    * Super Class * 
    * @package Package Name 
    * @subpackage Subpackage 
    * @category Category 
    * @author Author Name 
    * @link http://example.com 
    */ 
    class Super_class { 

來源:Click!

在像netbeans的集成開發環境,該註釋樣式檢測和*指針是自動生成(如列表指針)。您只需打開/**並按Enter鍵即可!