如何自動生成基於Yii的Web應用程序的文檔

我一直在開發一個基於Yii框架的Web應用程序，其中約有60％的代碼在javascript中。在開發過程中，我無法創建功能/代碼等的同步文檔，但它只是與代碼一起編寫的非結構化評論。如何自動生成基於Yii的Web應用程序的文檔

我想在HTML文檔中自動生成我的web應用程序的文檔，該文檔顯示與代碼混合的註釋。

我試圖yiidocumentor但輸出是更Yii的本身的文檔和它不記錄JavaScript函數
Docco是貌似最好的解決方案，但它是用於的NodeJS基於應用和我嘗試使用端口的Docco在php（sourceMakeup），但它沒有顯示任何錯誤，但沒有顯示任何結果。另外，爲了使用sourceMakeup，我不得不將這些文件移到Yii框架之外，因爲我無法在Yii框架內使用它。

如果任何人都可以從源代碼和註釋中提供一些自動生成文檔的指導，這將有很大的幫助。

非常感謝！

2014-01-07 Shivang Doshi

我終於使用Natural Docs，因爲它簡單，高效並支持多種語言。所需要的只是一個非常小的結構，即在評論中，即

/* 
Function: Multiply 

Multiplies two integers. 

Parameters: 

    x - The first integer. 
    y - The second integer. 

Returns: 

    The two integers multiplied together. 

See Also: 

    <Divide> 
*/

來源

2014-01-09 05:23:32

我的建議是phpdoc .phpDocumentor是一個可以從PHP源代碼生成文檔的工具。

來源

2014-01-08 16:09:45 ShahRokh

thnks fr回覆！ –

如何自動生成基於Yii的Web應用程序的文檔

回答

相關問題