angularJS函数的Doxygen注释

Doxygen comment for angularJS function

本文关键字：注释 Doxygen 函数 angularJS      更新时间：2023-11-01

我的项目使用angularJS和doxygen。

在我的角度控制器中，我有一些定义如下的功能：

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

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

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

你有主意吗？

谢谢！

也许$scope参数混淆了Doxygen。如果我将名称仅更改为"scope"，并在@param注释中将"page"替换为"scope"，那么Doxygen可以正常工作。它生成了一个具有适当内容的函数声明文档部分。

Doxygen并没有声称支持JavaScript，但由于$符号，如果JavaScript看起来不像PHP，它确实可以工作。

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

相关文章：