Question

我想知道是否有人可能知道将文件/存储库的Git版本插入注释块的方法，以便PHP Doc可以在生成文档时自动反映它？

Answer 1

phpDocumentor不是将这些信息放入文档的内容......它必须已经出现在您的文档块中。

听起来你习惯在你的docblock中拥有$ Id $标签，当你查看代码时，CVS和SVN会自动填充...也就是“Keyword Expansion”。

Git确实允许这样做 - https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#_keyword_expansion。

Answer 2

您可以创建一个能够找到项目最新版本的phing脚本。并使用每个文件/所选文件中的版本替换令牌。

例如（我在示例中使用过SVN）在你的剧本

获取最新的svn版本

<svnlastrevision workingcopy="${path.to.project.dir}" propertyname="svn.lastrevision" />

在您想要svn版本的文件中，输入名称为@svn.lastrevision@

的令牌

以下代码将使用版本号

替换此令牌

<!-- Apply the version change to all files. -->
        <reflexive>
            <fileset dir="${dir.to.change.version}">
                 <include name="**/*.*" />
            </fileset>
             <filterchain>
                <replacetokens>
                    <token key="svn.lastrevision" value="${svn.lastrevision}" />
                </replacetokens>
            </filterchain>
        </reflexive>

使用PHPDoc自动添加Git版本

2 个答案: