2011-05-07 14 views
33

Después de crear un método, uso /**<enter> para generar DocBlock. Rellena automáticamente @param y @return para esa función. Ejemplo:¿Cómo personalizo NetBeans PHP auto DocBlock para métodos y atributos?

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

¿Cómo puedo personalizar el bloque que se genera de modo que también se llena en el @author y terminar con esto después de /**<enter>

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

Gracias

+0

No he visto ninguna opción para esto, ni puede agregarlo manualmente con Plantillas de código ya que no funcionarán en los comentarios. Me interesaría averiguar si hay alguna manera de hacer esto. – Fanis

+6

No tengo idea, ** PERO ** mientras tanto, podría usar macros para hacerlo. Tengo macros '@ copyright' y' @ author' cuando docblocking classes. También sugeriría '@ author''ing la clase, en lugar de cada método individual. – ShotgunToothpaste

+0

@ Shadower856 ¡Ni siquiera había notado las capacidades de macros en 2 años de usar netbeans! He estado usando Plantillas de código, pero esas no funcionarán fuera de las áreas de código. Great tip – Fanis

Respuesta

5

Puede haber una mejor forma de hacerlo, pero esto es lo que he utilizado: 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 información sobre esto en el sitio de la documentación Netbeans:

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

4

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

creo que querrá mirar el --customtags Conmutador de línea de comandos.

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

no he intentado esto personalmente, pero he estado jugando con la idea de utilizar NetBeans en combinación con docblocks y PHPDocumentor a "automágicamente" crear una buena cantidad de documentación utilizable sin ser demasiado extenuante en el resto de los codificadores ;-)

Hay un buen video tutorial sobre cómo configurar NetBeans para trabajar con PHPDocumentor disponible aquí: Generating PHP Documentation With NetBeans IDE 7.0

3

Para habilitar adecuada terminación automática de etiquetas @author, sólo tiene que ir a: Herramientas> Plantillas-> PHP> PHP Clase, presione el botón "Configuración" y elimine el comentario de 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.

+0

Esto funciona para la clase que es útil, pero no funciona para la función de bloques de documentos que es lo que el OP está pidiendo – icc97

0

Respuestas cortas de varias fuentes: No, no puede editar una plantilla que podría agregarlo.

  1. Si todavía está buscando una característica por igual, se puede crear una macro hacer a él y luego se unen a un acceso directo ("Alt + W", por ejemplo).

para crear un Macro: Herramientas -> Opciones -> Editor -> Macros

Ejemplo:

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

esta macro ayuda a añadir PHPDoc con la mano izquierda lo que hace que sea 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.


  1. También puede establecer el autor general de su proyecto, vaya a: Herramientas -> Plantillas; Haga clic en "Configuración"

Añadir la línea:

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

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

Espero que esto te ayude!

Cuestiones relacionadas