2010-02-26 98 views
0

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

...还有什么其他标签可以在您的头顶有用吗?

编辑:

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

回答

1

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

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

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

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


编辑经历的phpdocumentor manual再次,我发现这一点:

的{} @inheritdoc内嵌标签中的类,方法和子类的类变量的文档块中使用。 phpDocumentor将自动继承父类的@author标记,@version标记和@copyright标记。另外,如果没有文档评论,它会继承父文档。

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

这不完全是你在找什么,但它是一个类似的方向。

+0

这是一种混乱。在一部分中,我同意应该有一种方法来跟踪文件的版本,另一方面,“已发布”文档应该用于版本X.Y.Z.我会再次看IDE设置谢谢:) – Urda 2010-02-27 20:52:02

+0

@Urda您可以通过在您的源代码存储库中标记或分支您的应用程序来处理此问题。我也再次更新了答案。 – Gordon 2010-02-28 09:51:41

+0

关于inheritdoc的有趣故事。我似乎永远无法按预期工作。星期五试了两个小时左右。 – Urda 2010-02-28 19:06:14

相关问题