php - para - netbeans code templates java

¿Cómo personalizo NetBeans PHP auto DocBlock para métodos y atributos?

Question

Después de crear un método, uso /**<enter> para generar el DocBlock. Rellena automáticamente @param y @return para esa función. Ejemplo:

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

¿Cómo puedo personalizar el bloque que se está generando para que también rellene el @author y termine con esto después de /**<enter>

/**
*
* @param type $str
* @return type
* @author John Doe <[email protected]>
*/
public function strlen($str){
return strlen($str);
}

Gracias

Answer 1

Creo que la respuesta que está buscando se encontrará aquí: phpDocumentor Tutorial

Creo que querrás mirar el modificador de la línea de comandos --customtags.

Así que lo más probable es que, cuando vaya a Herramientas -> Opciones -> "PHP" -> "PHPDoc", puede agregar que --customtags línea de comandos cambie a la línea de script PHPDoc.

No lo he intentado personalmente, pero he estado jugando con la idea de usar NetBeans en combinación con DocBlocks y PHPDocumentor para crear "automágicamente" una buena cantidad de documentación útil sin ser demasiado extenuante con el resto de los codificadores. ;-)

Hay un buen video tutorial sobre la configuración de NetBeans para trabajar con PHPDocumentor disponible aquí: Generación de documentación PHP con NetBeans IDE 7.0

Answer 2

Para habilitar la autocompletación de @authoretter, solo vaya a: Tools-> Templates-> PHP-> PHP Class, presione el botón "Settings" y descomente la línea que comienza con #user= . Ahora puede editar el nombre y el correo electrónico, que se pasan a su comentario de clase.

Answer 3

Puede haber una mejor manera de hacerlo, pero esto es lo que he usado: en Herramientas> Opciones> Editor> Plantillas de código, hay algunos combos predefinidos para generar código rápidamente. Una de las plantillas predeterminadas en 7.0 es:

vdoc<tab>

Esto genera un pseudo-docblock y la definición de la variable. Puede reemplazar esto y agregar nuevos que se expandan en cualquier texto que desee, al igual que las abreviaturas vim. Puede encontrar más sobre esto en el sitio de documentación de Netbeans:

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

Answer 4

Respuesta breve de varias fuentes: No, no puede editar una plantilla que pueda agregarla.

1. Si todavía está buscando una característica por igual, puede crear una Macro do y luego vincularla a un acceso directo ("Alt + W" por ejemplo).

Para crear una macro : Herramientas -> Opciones -> Editor -> Macros

Ejemplo:

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

Esta macro ayuda a agregar PHPDoc con la mano izquierda, lo que lo hace más rápido. Puede generar lo que desee generar, como usar esta macro, colocar el cursor en el lugar correcto y luego agregar el @author YOUR_NAME al final del comentario.

2. También puede configurar el Autor general de su proyecto en: Herramientas -> Plantillas; Haga clic en "Configuración"

Agrega la línea:

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

Esto agregará @author a todas las nuevas definiciones de clase / interfaz.

¡Espero que esto ayude!