phpDocumentor page-level docBlock в html-файле

Я использую инструмент из phpdoc.org и я застрял, когда у меня есть PHP-файл, такой как header.инк.в PHP с HTML внутри.

<?php
    /**
    * Header content
    *
    * @author  My name
    *
    * @since 1.0.0
    */
?>
<!DOCTYPE html>
<html lang="fr" class="no-js"> 
    <head>
...

Я получаю ошибку в моем phpdoc "в файле не найден Докблок уровня страницы...". Я погуглил его, но не нашел ни одного пользователя с моим делом.

Как исправить эту ошибку? Любые советы приветствуются.

Спасибо!

С уважением

2 2
phpdoc

2 ответа:

Я только что наткнулся на это сообщение, и хотя оно старше, я подумал, что добавлю свои два цента. В то время как sylouuu правильно размещает пространство имен непосредственно после предполагаемого уровня страницы DocBlock, я считаю, что теперь требуется поместить тег "@package " в DocBlock. Здесь есть некоторая осторожность при работе с логическими и иерархическими "пакетами". Это поведение в основном зависит от того, какую версию PHPDocumentor вы используете.

От: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html "В документатора РНР версии 1.2.2, а на уровне страниц doc-блок-первый заголовочный блок в файл, если он содержит тег @пакет."

И в https://github.com/phpDocumentor/phpDocumentor2/issues/910 можно прочитать, что еще месяц назад вопрос о блокировках на уровне страниц в файлах без PHP-кода/узлов все еще разрабатывался. Таким образом, как sylouuu заявил о добавлении пространства имен, как только вы сделаете это, у вас появится документальный элемент, и ваша проблема должна быть решена. Кроме того, поскольку, скорее всего, никакая документация для страницы не будет создана без наличия узла, это позволяет создать документацию только для html-файла.

Надеюсь, это поможет! dw

1

Ok anwser найдено: https://github.com/phpDocumentor/phpDocumentor2/issues/695

TL; DR: На данный момент это не исправлено, просто игнорируйте предупреждения тезисов.

0