在PhpDocumentor中,有没有办法指定默认版本号?

时间:2010-02-26 16:35:17

标签: php documentation phpdoc

我正在记录的代码库中的所有文件将始终使用相同的版本“字符串”是否有一种方法可以在一个地方特定,PhpDocumentor对所有文件使用相同的版本,无论是否指定与否(应自动继承)

......还有哪些其他标签对你来说有用?

编辑:

任何可以绕过亲子关系的东西?像.ini或配置文件,用于阅读版本,作者,版权?

1 个答案:

答案 0 :(得分:1)

我不知道PHPDocumentor允许这样的内容。

此外,在所有文件上使用相同的版本对我来说似乎是错误的用法。版本注释提供特定文件的版本。如果您要修复A类中的错误,为什么B类的版本会发生变化?

至于在多个文档中插入相同的注释,我建议查看您的IDE模板功能。通常,您可以配置这样的代码段,并使用键盘快捷键或创建新文件时插入它们。

另一种选择是在通过部署脚本(如Phing或Ant)或通过代码存储库中的预提交挂钩创建文档时设置和替换注释值。


编辑再次浏览phpdocumentor manual,我发现了这一点:

  

{@inheritdoc}内联标记用于子类的类,方法和类变量的DocBlock。 phpDocumentor将自动从父类继承@author标记,@ version标记和@copyright标记。此外,如果没有文档注释,它将继承父文档。

     

请注意,如果{@inheritdoc}内联标记不存在,并且子类未记录,则子类仍将尝试从父类继承文档。 {@inheritdoc}允许灵活地将父类的文档放在子类的文档中。

这不完全是你想要的,但它是一个类似的方向。