Проблемы с запуском phpdoc

Question

У меня возникли проблемы с началом работы с phpdoc. Я создал пример файла php. Это код:

<?php 
/** 
* short comment 
*/ 

/** This is the 
* longer comment 
*/ 

/** 
* @author My Name <my.name@example.com> 
*/ 
    echo "Hello, World"; 
?> 

Насколько я понимаю, теперь я должен быть в состоянии сделать документацию этого кода с помощью следующей команды:

phpdoc project:run -f C:\xampp\htdocs\libs\test.php -t C:\phpdoc\ 

файл test.php является файл, который я вставил здесь. C: \ phpdoc \ где должна располагаться документация. Теперь, когда я туда иду, создается несколько файлов и папок, но когда я открываю файл index.php и cklick на «Global()», мое окно выглядит следующим образом:

[Я бы разместил изображение здесь, но моя репутация для этого низкая. Я пытаюсь описать, как это выглядит: это похоже на веб-страницу с недопустимым путем для файла css. Все изображения и пользовательские кнопки отсутствуют, а шрифт - только обычный шрифт римского шрифта. Нет фонового изображения и т. Д.]

Почему это? Что я делаю не так?

BTW: Я использую Windows 7 x64 и новую версию (также недавно установлен) из XAMPP

С наилучшими пожеланиями и большое спасибо за чтение

Answer 1

Я использую apigen сделать свои PHP docblocks от Я иду чтобы предположить, что phpdoc работает одинаково. То, что вы хотите сделать, это положить все из тех, в единый блок, например, так:

/** 
* Short description, keep to one line. 
* 
* Long description, you can break this up 
* over multiple lines. 
* 
* @author your.name@yourplace.com 
* @param incoming The variable that is being sent in 
* @return bool Type of variable to return and explanation of return value 
*/ 
public function doStuff($incoming) { 
    //Do stuff here 
    return true; 
} 

Вы можете поместить эти вышеуказанные функции, переменные, классы. Как правило, первый docblock, который вы делаете для файла, становится docblock для всего файла.