0

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

...还有哪些其他标签对您的头脑有用?

编辑:

有什么可以绕开亲子关系的?用于读取版本、作者、版权的 .ini 或配置文件之类的东西?

4

1 回答 1

1

我不知道 PHPDocumentor 允许这样的事情。

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

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

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


编辑再次浏览phpdocumentor 手册,我发现了这个:

{@inheritdoc} 内联标签用于子类的类、方法和类变量的 DocBlocks。phpDocumentor 将自动从父类继承@author 标签、@version 标签和@copyright 标签。此外,如果不存在文档注释,它将继承父文档。

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

这不完全是您正在寻找的东西,但它是一个相似的方向。

于 2010-02-26T21:22:45.630 回答