Как настроить автоматический DocBlock PHP для NetBeans для методов и атрибутов?

Question

После создания метода я использую /**<enter> для генерации DocBlock.Для этой функции автоматически заполняются значения @param и @return.Пример:

/**
 *
 * @param type $str
 * @return type 
 */
public function strlen($str){
    return strlen($str);
}

Как настроить сгенерированный блок так, чтобы он также заполнял @author и заканчивал этим после /**<enter>

/**
 *
 * @param type $str
 * @return type 
 * @author John Doe <john@doe.com>
 */
public function strlen($str){
    return strlen($str);
}

Спасибо

Answer 1

Возможно, есть лучший способ сделать это, но вот что я использовал: в разделе Инструменты> Параметры> Редактор> Шаблоны кода есть несколько предопределенных комбинаций для быстрой генерации кода. Один из шаблонов по умолчанию в 7.0:

vdoc<tab>

Создает псевдодоблок и определение переменной. Вы можете заменить это и добавить новые, которые расширяются в любой текст, который вы хотите, как аббревиатуры vim. Вы можете найти больше об этом на сайте документации Netbeans:

http://netbeans.org/kb/docs/php/code-templates.html#using-templates

Answer 2

Я думаю, что ответ, который вы ищете, будет найден здесь: Учебник phpDocumentor

Я думаю, вы захотите взглянуть на ключ командной строки --customtags.

Поэтому, скорее всего, когда вы идете в Инструменты -> Параметры -> "PHP" -> "PHPDoc", вы можете добавить этот переключатель командной строки --customtags в строку сценария PHPDoc.

Я не пытался сделать это лично, но я играл с идеей использовать NetBeans в сочетании с DocBlocks и PHPDocumentor для «автоматического» создания большого количества полезной документации, не слишком при этом напряженный на остальных кодеров. ; -)

Существует хорошее видеоурок о настройке NetBeans для работы с PHPDocumentor, доступный здесь: Создание документации PHP с помощью IDE NetBeans 7.0

Answer 3

Чтобы включить правильное автозаполнение тега @author, просто зайдите в: Инструменты-> Шаблоны-> PHP-> PHP Class, нажмите кнопку «Настройки» и раскомментируйте строку, начинающуюся с #user=.Теперь вы можете редактировать имя и адрес электронной почты, которые передаются в ваш комментарий класса.

Answer 4

Краткий ответ из разных источников: Нет, вы не можете редактировать шаблон, который может добавить его для вас.

1. Если вы все еще ищете какую-либо функцию, вы можете создать для нее Macro do и затем привязать ее к ярлыку (например, «Alt + W»).

Чтобы создать Макрос : Инструменты -> Параметры -> Редактор -> Макросы

Пример:

Alt+W => insert-break "/**" insert-break

Этот макрос помогает добавлять PHPDoc левой рукой, что делает его быстрее. Вы можете сгенерировать все, что захотите, например, используя этот макрос, а затем поместите курсор в нужное место и добавьте @author YOUR_NAME в конце комментария.

---

2. Вы также можете установить общего автора вашего проекта, перейдя в: Инструменты -> Шаблоны; Нажмите «Настройки»

Добавить строку:

user=YOUR NAME <email.prefix at domain.extension>

Это добавит @author ко всем вашим новым определениям классов / интерфейсов.

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