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

После создания метода я использую /**<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 <[email protected]>
 */
public function strlen($str){
    return strlen($str);
}

Спасибо

Ответы

Ответ 1

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

vdoc<tab>

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

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

Ответ 2

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

Я думаю, вам нужно посмотреть на ключ командной строки --customtags.

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

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

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

Ответ 3

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

Ответ 4

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

  • Если вы все еще ищете подобную функцию, вы можете создать с ней Макро, а затем привязать ее к ярлыку (например, "Alt + W" ).

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

Пример:

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

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

  1. Вы также можете задать общий автор своего проекта, выбрав: Инструменты → Шаблоны; Нажмите "Настройки"

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

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

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

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