instalar - vim plug in manager

VIM Insertar PHPdoc automáticamente

Question

¿Hay una manera de insertar PHPDoc en VIM usando un comando o combinación de teclas?

Por ejemplo, tengo una clase:

class MyClass
{

  public function __construct() { }
  public function __destruct() { }

  /* command here to insert PHP doc */
  public function abc() { }

}

Me gustaría insertar algo como:

/**
* method() 
*
* description
*
* @access   
* @author    
* @param    type    $varname    description
* @return   type    description
* @copyright
* @version
*/

Y luego puedo completar el resto manualmente. Gracias

Answer 1

Esto se puede hacer de manera bastante efectiva con el here ligero here .

Editar Aquí hay una versión modificada con un desarrollo más reciente.

Editar Aquí está la versión 2 del complemento phpDocumentor . Es más reciente que los dos enlaces anteriores.

Instale el complemento en su $VIMFILES/plugin y agregue esto a su .vimrc:

" PHP documenter script bound to Control-P
autocmd FileType php inoremap <C-p> <ESC>:call PhpDocSingle()<CR>i
autocmd FileType php nnoremap <C-p> :call PhpDocSingle()<CR>
autocmd FileType php vnoremap <C-p> :call PhpDocRange()<CR> 

Lo anterior une phpDocumentor a Ctrl p en los modos de inserción, normal y visual. Coloque el cursor en una definición de clase, función o variable, presione Ctrl p , y el complemento intentará formar un bloque de documentos basado en la definición.

Bloque doc de ejemplo de función:

/**
 * testDocBlock 
 * 
 * @param mixed $param1 
 * @param mixed $param2 
 * @static
 * @access public
 * @return boolean
 */
public static function testDocBlock($param1, $param2) {
  // Pressed Ctl-p while cursor was on the function definition line above...
}

Ejemplo de bloque doc de clase

Los derechos de autor, versión, autor, etc. se incluyen de manera predeterminada en un bloque de documentos de clase. Puede modificar el complemento para incluir sus propios valores predeterminados para estos:

/**
 * TestClass  
 * 
 * @package 
 * @version $id$
 * @copyright 
 * @author Michael <[email protected]> 
 * @license 
 */
class TestClass {

}

Ejemplo de clase de resumen completo:

<?php
/**
 * TestClass 
 * 
 * @abstract
 * @package 
 * @version $id$
 * @copyright 
 * @author Michael <[email protected]>
 * @license 
 */
abstract class TestClass {
  /**
   * publicProp  
   * 
   * @var string
   * @access public
   */
  public $publicProp;
  /**
   * privateProp  
   * 
   * @var string
   * @access private
   */
  private $privateProp;

  /**
   * testDocBlock  
   * 
   * @param string $param1 
   * @param string $param2 
   * @static
   * @access public
   * @return boolean
   */
  public static function testDocBlock($param1, $param2) {
    // code here...
  }
}
?>

Answer 2

No puedo hablar específicamente de PHP pero tienes un par de opciones. Puede usar abbreviations (tal vez no sea bueno para el ejemplo específico) o puede buscar un complemento. Puedo sugerir https://github.com/garbas/vim-snipmate (lo uso y funciona bien).

Answer 3

Supongamos que coloca su plantilla en ~ / templates / phpdoc.php. Con la siguiente abreviatura, si escribe ,p , leerá el contenido de su phpdoc.php en el archivo actual, (en o debajo de la línea actual, uno de ellos).

map ,p :r ~/templates/phpdoc.php<cr>

Luego simplemente agregue la línea a su archivo .vimrc, reemplazando la ruta del archivo y ,p a su gusto.