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注释中将“page”替换为“scope”，那么Doxygen工作正常。它生成一个具有适当内容的函数声明文档部分。

Doxygen并不声称支持JavaScript，但如果JavaScript看起来不像PHP，那么它确实有效。感谢$符号。

也许这个链接也有帮助：http://blog.coherent-labs.com/2012/10/documenting-javascript-with-doxygen.html

对angularJS函数的Doxygen评论

1 个答案: