phpDoc中是否可以使用自定义标记?
phpDoc支持自定义标记吗?我想使用phpDoc中是否可以使用自定义标记?,php,phpdoc,Php,Phpdoc,phpDoc支持自定义标记吗?我想使用@untested来标记尚未测试的代码。如何做到这一点呢?为什么不像这样使用标签呢 我认为添加自定义标记不是一个好主意。尽管PHPDoc仍然是非正式的,但它很可能在不久的将来成为正式的标准。所以如果我是你,我会尽可能坚持使用官方标签 无论如何,(截至2020年5月仍在起草中)允许自定义标记,前提是您在它们前面加上项目或组织特定的名称: 为了支持注释,允许引入一组专门为单个应用程序或应用程序子集设计的标记(因此本规范未涵盖) 这些标记或注释必须通过以下方式提供
@untested
来标记尚未测试的代码。如何做到这一点呢?为什么不像这样使用标签呢
我认为添加自定义标记不是一个好主意。尽管PHPDoc仍然是非正式的,但它很可能在不久的将来成为正式的标准。所以如果我是你,我会尽可能坚持使用官方标签 无论如何,(截至2020年5月仍在起草中)允许自定义标记,前提是您在它们前面加上项目或组织特定的名称:
为了支持注释,允许引入一组专门为单个应用程序或应用程序子集设计的标记(因此本规范未涵盖)
这些标记或注释必须通过以下方式提供名称空间:
使用PHP样式的命名空间作为标记名的前缀,或通过
在标记名称前面加上一个供应商名称,后跟连字符
以供应商名称和连字符作为前缀的标记名示例:
@phpdoc事件转换器.transform.pre
因此,假设PSR-5被接受,您似乎可以执行类似于
@myproject untested
的操作。即使PSR-5被接受,也不能保证phpDoc工具将支持定义这些自定义标记的方法。您尝试过在谷歌搜索吗@感谢2009年的文章。看起来phpDoc不支持不进入并更改其代码的标记。同时,这似乎是可能的。看看:
/**
* Here comes the summary
*
* @todo this code has to be tested
*
* @return boolean Returns something
*/
function someFunction()
{
<...>
}
/**
* Here comes the summary
*
* {@internal this code has to be tested }}
*
* @return boolean Returns something
*/
function someFunction()
{
<...>
}