В PhpDocumentor есть способ указать номер версии по умолчанию? - PullRequest
0 голосов
/ 26 февраля 2010

Все файлы в кодовой базе, которую я документирую, всегда будут использовать одну и ту же версию "string". Есть ли способ указать в одном месте, чтобы PhpDocumentor использовал одну и ту же версию для всех файлов, независимо от того, указана ли она или нет (должен автоматически наследоваться)

... а какие еще теги будут полезны для головы?

Edit:

Что-нибудь, что могло бы обойти отношения родителей и детей? Что-то вроде .ini или файла конфигурации для чтения в версии, автор, авторское право?

1 Ответ

1 голос
/ 27 февраля 2010

Я не знаю, PHPDocumentor позволяет что-то подобное.

Кроме того, использование одинаковой версии для всех файлов мне кажется неправильным. Аннотация версии дает версию для определенного файла. Если бы вы исправили ошибку в классе A, почему изменилась бы версия класса B?

Что касается вставки одних и тех же аннотаций в несколько документов, я предлагаю изучить шаблонную функцию ваших IDE. Обычно вы можете настроить подобные фрагменты и вставлять их с помощью сочетаний клавиш или при создании новых файлов.

Другой вариант - установить и заменить значения аннотаций при создании документации с помощью сценария развертывания, такого как Phing или Ant, или с помощью ловушки перед фиксацией в вашем хранилище кода.


РЕДАКТИРОВАТЬ Проходя руководство phpdocumentor снова, я нашел это:

Встроенный тег {@inheritdoc} используется в DocBlocks классов, методов и переменных класса дочерних классов. phpDocumentor автоматически унаследует теги @author, тег @version и тег @copyright от родительского класса. Кроме того, если нет комментариев к документации, он унаследует документацию родителя.

Обратите внимание, что если встроенный тег {@inheritdoc} отсутствует, а дочерний класс недокументирован, дочерний класс все равно будет пытаться наследовать документацию от родительского класса как есть. {@inheritdoc} позволяет гибко размещать документацию из родительского класса в документации дочернего класса.

Это не совсем то, что вы ищете, но это похожее направление.

...