instalar - ¿Hay funciones de comentar código como DocBlockr en Visual Studio Code?
visual studio code @param (6)
Utilizo Sublime Text 3, Atom.io y Bracket.io como editores anteriores.
También estoy disfrutando mucho del nuevo Visual Studio Code Editor para Mac.
¿Hay algún código para comentar características similares a DocBlockr para Sublime? Esto es bastante crucial para mí, ya que comento muchísimo código.
Completa el bloque si escribe /**[enter] y luego se formatea cualquier escritura dentro del bloque (por ejemplo, presione enter en una línea que comienza con un * y otra se inserta debajo con un *).
Pero una característica realmente interesante de DocBlockr es que escanea el código a continuación y agrega declaraciones de @param en el bloque. VS Code no parece hacer esto.
El Visual Studio Code Marketplace ahora tiene una extensión de bloqueo de documentos para JavaScript y otras pueden agregarse pronto. https://marketplace.visualstudio.com/items?itemName=stevencl.addDocComments
Anteriormente, tenía apoyo parcial para esto. Como lo mencionaron otros, puede obtenerlo escribiendo /** y luego ENTRAR pero solo si está en un archivo JavaScript. No creo que funcione en ningún otro idioma.
Algunas características similares habían sido solicitadas:
Hay https://marketplace.visualstudio.com/items?itemName=neilbrayfield.php-docblocker .
No es tan poderoso como en PHPStorm. Pero puede detectar parámetros de función y agrega líneas de plantilla para ello.
Si desea comentarios de parámetros para funciones o vacíos, simplemente escriba /// como un bono que aparecerán también en los puntos destacados del mouseover
Si escribe /** , ENTER y obtiene el formato js doc en el código de estudio visual
A partir de hoy, y la versión v1.1 no hay , sin embargo, es una función muy votada. Votaría por esta función si le resultara útil, @mattferderer ha publicado los enlaces de características a los que debe agregar sus votos. Hasta entonces, hay 2 complementos que funcionan muy bien juntos:
Documento Este ( ext install docthis ) generará comentarios de estilo JsDoc para muchas anotaciones de estilo JsDoc. Use el comando Ctrl + Alt + D en o dentro de donde desea generar documentación.
Esto funciona bien con el complemento "Complete JsDoc Tags"
Etiquetas completas de JsDoc ( ext install JSDocTagComplete ) Proporciona la finalización del código para la mayoría de las anotaciones de estilo JsDoc usando Ctrl + space .
Usar estos 2 complementos juntos funciona de manera muy eficiente. DocThis proporciona el comentario inicial generado con Ctrl + Alt + D , y luego puede usar ctrl + space para agregar anotaciones JsDoc específicas. DocThis no ve / genera.
No encontré que el complemento " https://marketplace.visualstudio.com/items?itemName=stevencl.addDocComments JsDoc" a las menciones de @mattferder sea muy útil. Solo te proporciona una etiqueta @param y @return y nada más ...