Doxygen評論angularJS功能

Question

我使用angularJS和doxygen爲我的項目。

在我的角度控制器，我有這樣定義的一些功能：

function MyCtrl($scope) { 
    /** 
     * @param page String Page name 
     * @ingroup API 
     * @author Sylvain 
     */ 
    $scope.prev = function(page) { 
     ... 
    } 

    ... other functions 
} 

我想是doxygen的理解這段代碼的函數聲明。

我試過使用@fn命令，但是doxygen連接了MyCtrl函數文檔中的所有角函數註釋，而不創建新的功能塊。

你有什麼想法嗎？

謝謝！

Answer 1

也許$ scope參數令Doxygen混淆不清。如果我將名稱更改爲「範圍」，並在@param註釋中將「頁面」替換爲「範圍」，則Doxygen可以正常工作。它生成一個函數聲明文檔部分，並帶有適當的內容。

Doxygen並不聲稱支持JavaScript，但如果JavaScript看起來不像PHP那樣看起來像$符號。

也許這個鏈接也會有幫助：http://blog.coherent-labs.com/2012/10/documenting-javascript-with-doxygen.html