phpdoc - phpDoc中的多个@todo

Question

我想为一个功能添加多个待办事项。

将它们添加到 phpDoc 注释 block 中的正确方法是什么？

我知道我应该使用@todo 标签。但我不确定是应该为每个项目使用一个 @todo 标签，还是为整个列表使用一个 @todo 标签。

Answer 1

零个或多个 @todo 标签是有效的。

PSR-5: PHPDoc

语法

@todo [description]

例子

/**
 * Counts the number of items in the provided array.
 *
 * @todo add an array parameter to count
 *
 * @return int Returns the number of elements.
 */
function count()
{
    <...>
}