Автоматически добавлять версию Git с PHPDoc - PullRequest
Новая
       13

Автоматически добавлять версию Git с PHPDoc

4 голосов
/ 25 января 2012

Мне было интересно, кто-нибудь может знать, как вставить версию Git для файла / репозитория в блок комментариев, чтобы PHP Doc мог автоматически отразить это при создании документации?

Ответы [ 2 ]

1 голос
/ 25 января 2012

phpDocumentor - это не то, что помещает эту информацию в документы ... она должна уже появиться в вашем блоке документов.

Похоже, вы привыкли иметь теги $ Id $ в ваших док-блоках, которые автоматически заполняются CVS и SVN, когда вы проверяете код ... aka "Расширение ключевого слова".

В Git это разрешено - https://git -scm.com / book / ru / v2 / Настройка-Git-Git-Attributes # _keyword_expansion .

0 голосов
/ 25 января 2012

Вы можете создать скрипт phing, который найдет последнюю версию вашего проекта.И замените токен версией в каждом файле / выбранных файлах.

Например (я использовал SVN в примере) в вашем скрипте phing

, чтобы получить последнюю версию 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>
...