2013-11-01 4 views
0

Я недавно установил PHPDocumentator 2 и, как и раньше. Одна вещь, которую я хотел бы сделать, - это упорядочить файлы более значимым образом (в частности, используя фактическую структуру папок) и в алфавитном порядке.Организация файлов в PHPDocumentator

Вот скриншот из моих классов, как это стоять прямо сейчас:

enter image description here

Обратите внимание, что они не в алфавитном порядке на всех. Фактическая структура папок следующим образом:

system/ 
    - Database 
    - all Form classes 
    - Tester 
extra/ 
    - Registration 
    - ConfigForm 

Я не использую пространство имен, но у меня есть @ пакет на всех классах.

Могу ли я исправить это в phpdoc.dist.xml или мне нужно создать новый шаблон?

Любой совет будет рад!

Редактировать: Вот пример DocBlock:

/** 
    * FormElement Class 
    * 
    * @category System 
    * @package Form 
    */ 
abstract class FormElement 
{ 
+0

Если вам все еще интересно, вы можете следить за ходом выполнения этого запроса функции в [этом сообщении об ошибке github] (https://github.com/phpDocumentor/template.clean/issues/2). – eykanal

ответ

1

В пробуя различные шаблоны вывода, доступные с PhpDocumentor 2.1.0, я вижу, что некоторые делают это в алфавитном порядке левосторонний листинг, в то время как другие этого не делают , Возможно, даже вероятно, что те, которые не алфавитно перечисляют список, являются ошибками в этих шаблонах.

Что касается вашей организации через @package, ваши ожидания верны. Тем не менее, я вижу на вашем изображении, что вы показываете «\» глобальное пространство имен, а не список пакетов. Вам нужно выбрать шаблон, основанный на представлении представления пакетов. Я бы предложил сначала попробовать шаблон Abstract и посмотреть, подходит ли он вам по вкусу. Я вижу, что он в алфавитном порядке перечисляет его список Пакетов, а также его список классов в пакете.

+0

Реферат делает больше того, что я хочу наверняка. Желаю, чтобы документация phpdoc была лучше! Кажется, мне это должно быть. Есть ли хорошее руководство для создания шаблона с phpdoc? –

+0

Путеводитель по баребонам здесь (http://www.phpdoc.org/docs/latest/for-template-builders/getting-started/quick-start.html). Более подробное руководство планируется позже. – ashnazg

+0

большое спасибо –

Смежные вопросы