phpDocumentor的如何避免*在每一個新的註釋行

Question

根據PhpDocumntor以評論的每一塊被轉換成文檔的有效部分的前需要進行封裝這樣的：

/** 
* This function is used blah, blah, blah 
* line 2 
* line 2 
* ... 
*/ 
function MyFunc($string) {... 

你知道如果可能的話（可以通過改變一些設置）來避免被迫在每行之前放置一個星號。 我想基本上是這樣的phpDocumentor接受並轉化爲文檔這些類型的評論：

/** 
This function is used blah, blah, blah 
line 2 
line 2 
... 
*/ 
function MyFunc($string) {... 

我這麼問是因爲JsDOC和JavaDoc中並不需要在每個新行了的前一個該死的星號，所以我認爲也許PhpDocumentor可以通過欺騙一些它的設置來做到這一點，但我在Google上找不到任何關於此的信息。

Answer 1

有沒有辦法使用PhpDocumentor來做到這一點。

我放棄了PhpDocumentor並使用Doxygen開始。對於任何可能感興趣的人來說，Doxygen允許最終用戶以多種方式記錄PHP函數，其中還包括JavaDoc和JsDoc等其他。而你不是被迫放置一個「該死的」星號在文件的每一行的開始，所以下面的評論都OK，會被Doxygen的正確解析：

/** 
... line1 ... 
... line2 ... 
*/ 
function MyFunc($string) {... 

Answer 2

您必須記住，如果您更改了PhpDoc創建文檔/自動完成信息的方式，最終用戶需要更改其設置以及希望通過文檔/自動完成信息查看您的代碼。

我不知道PhpDoc中的這個選項，但是您可以嘗試使用DocBlock模板來播放。

這是一個link玩文檔塊模板。

Answer 3

也許你應該使用一個編輯器爲你放置星號，所以你不必手動去做。幾乎所有與PHP兼容的IDE都可以這樣做，許多PHP編程人員也可以使用它。

使用這樣的星號是標準慣例。除非你的代碼將被隱藏在一個山洞裏，在沒有人會看到它的水泥之下，遵循標準慣例可能是一個好主意。