如何为可变参数函数(即参数数量未定义的函数)编写 Doxygen 注释?

发布于 2024-10-29 23:40:13 字数 114 浏览 1 评论 0原文

我正在尝试为具有无限数量参数的函数编写 doxygen 块注释,然后我找不到合适的标签。提供的参数应该都是字符串,它们将在函数中连接起来形成一个新的字符串。

doxygen 标签的正确用途是什么?

I am trying to write a doxygen block comment for a function with unlimited number of parameters, then I couldn't find a right tag for it. Supplied parameters should all be strings, and they will be concatenated in the function to form a new string.

What is the right use of doxygen tags?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

迷离° 2024-11-05 23:40:13

我经常在 phpdoc 中看到一种模式(格式为doxygen 理解的)是:

/** 
 * Shortdesc.
 * Longdesc.  Longdesc.  Longdesc.  Longdesc.  
 * @param mixed $something Description
 * @param mixed ... Description
 */
    function foo() { ... }

是的,字面上的 ... 作为变量名。

A pattern I see frequently in phpdoc (the format of which doxygen understands) is:

/** 
 * Shortdesc.
 * Longdesc.  Longdesc.  Longdesc.  Longdesc.  
 * @param mixed $something Description
 * @param mixed ... Description
 */
    function foo() { ... }

Yes, literally ... as the variable name.

亢潮 2024-11-05 23:40:13

实际上,phpDocumentor 上的语法是 $paramname,...

/**
 * Builds a file path with the appropriate directory separator.
 * @param string $segments,... unlimited number of path segments
 * @return string Path
 */
function file_build_path(...$segments) {
    return join(DIRECTORY_SEPARATOR, $segments);
}

Actually, the syntax on the phpDocumentor is $paramname,...

/**
 * Builds a file path with the appropriate directory separator.
 * @param string $segments,... unlimited number of path segments
 * @return string Path
 */
function file_build_path(...$segments) {
    return join(DIRECTORY_SEPARATOR, $segments);
}
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文