angularJS 函数的 Doxygen 注释答案

【问题标题】：Doxygen comment for angularJS functionangularJS 函数的 Doxygen 注释
【发布时间】：2013-11-27 14:24:41
【问题描述】：

我在我的项目中使用 angularJS 和 doxygen。

在我的角度控制器中，我有一些这样定义的函数：

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

     ... other functions
}

我希望 doxygen 将此代码理解为函数声明。

我曾尝试使用 @fn 命令，但随后 doxygen 将 MyCtrl 函数文档中的所有角度函数 cmets 连接起来，而不创建新的函数块。

你有什么想法吗？

谢谢！

【问题讨论】：

标签： javascript angularjs doxygen

【解决方案1】：

也许 $scope 参数让 Doxygen 感到困惑。如果我将名称更改为“范围”，并在您的@param 评论中将“页面”替换为“范围”，那么 Doxygen 可以正常工作。它会生成一个函数声明文档部分，其中包含适当的内容。

Doxygen 不声称支持 JavaScript，但如果 JavaScript 看起来不像 PHP，它确实可以工作，这要归功于 $ 符号。

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

【讨论】：