2013-08-01 64 views
0

我在開始使用phpdoc時遇到問題。 我創建了一個示例php文件。這是代碼:phpdoc入門問題

<?php 
/** 
* short comment 
*/ 

/** This is the 
* longer comment 
*/ 

/** 
* @author My Name <[email protected]> 
*/ 
    echo "Hello, World"; 
?> 

據我瞭解這一點,我現在應該能夠使這個代碼的文檔使用下面的命令:

phpdoc project:run -f C:\xampp\htdocs\libs\test.php -t C:\phpdoc\ 

的test.php的文件是我粘貼在這裏的文件。 C:\ phpdoc \是應該放置文檔的位置。現在,當我去那裏時,生成了幾個文件和文件夾,但是當我打開「index.php」文件並單擊「Global()」時,我的窗口看起來如下:

[I would have a Image在這裏,但我的聲譽是低的。我試圖描述它看起來如何:它看起來像一個無效的路徑到CSS文件的網頁。所有圖像和自定義按鈕都丟失,字體只是常規時間的新羅馬字體。沒有背景圖片等]

這是爲什麼?我究竟做錯了什麼?

BTW:我使用Windows 7 x64和XAMPP

的新版本(也新安裝)

閱讀

回答

0

我用apigen做我的PHP文檔塊最好的問候和感謝由我去推測phpdoc的工作原理是一樣的。你想要做的就是把所有這些成一個單一的塊,像這樣的內容:

/** 
* Short description, keep to one line. 
* 
* Long description, you can break this up 
* over multiple lines. 
* 
* @author [email protected] 
* @param incoming The variable that is being sent in 
* @return bool Type of variable to return and explanation of return value 
*/ 
public function doStuff($incoming) { 
    //Do stuff here 
    return true; 
} 

你可以把上面的那些函數,變量,類。通常,您爲文件創建的第一個docblock將成爲整個文件的docblock。

+0

嗨! 謝謝你的回答! 不幸的是我已經嘗試過,並沒有改變任何結果。 – Christian

+0

@ user2399808就docblock而言,這就是我用於apigen的東西。對於phpdoc可能會有所不同,但我不明白他們爲什麼會將塊拆分成更小的塊。對於另一個關於丟失圖像的問題,Windows 7中的UAC可能會因爲您正在寫入硬盤的根目錄而陷入困境,假設C:是您的Windows安裝位置。我會把你的輸出目錄移到別的地方(比如在C:\ xampp \ htdocs \ libs \ phpdoc \中)或者在管理模式下運行你的cmd,這樣phpdoc不會受到任何權限問題的阻礙。 – Crackertastic