¿Qué es esto?
Snippet Tool es una extensión para
Visual Studio, la cual mediante un menú desplegable en el menú contextual del editor de código, nos ayudará a realizar pequeñas pero repetitivas tareas de documentación XML y Snippets, para
C# y
VB.Net.
Snippet Tool no es una herramienta completa de documentación XML.
La idea principal fue desarrollar una simple extensión que me ayudase a automatizar la creación de archivos
Snippet desde el texto seleccionado en el editor (vease el comando "
Create Snippet File" en el menú contextual),
despues, decidí añadírle algunas funcionalidad adicionales cómo se puede comprobar en la imagen, a modo de complemento para cubrir necesidades que otras extensiones profesionales de documentación XML, cómo por ejemplo
Ghost Doc, no llevan a cabo.
La idea es utilizar dichas funcionalidades cómo complemento, en combinación de alguna otra extensión cómo la ya mencionada,
Ghost Doc.
Características
- Automatización para la creación de archivos .snippet administrados por Visual Studio.
- Automatización para la inserción de diversos tags cotidianos relacionados con la documentación XML.
- Los comandos del menú se pueden invocar mediante combinaciones de teclas pre-establecidas, por ejemplo al presionar CTRL + E + R, el texto seleccionado se insertará en el tag <see cref="texto"/>.
- Compatible con la sintaxis de C-Sharp y VisualBasic.Net.
Demostración
Estas imágenes pertenecen a la versión 1.0
Ejemplo de compilación y renderizado de la documentación
<member name="M:ConsoleApplication1.Program.TestFunc(System.Int32,System.Int32)">
<summary>
This is a test method that performs a loop.
</summary>
<example> This is a code example.
<code>
try
{
TestFunc(1, 10);
}
catch
{}
</code>
</example>
<param name="param1">
An <see cref="T:System.Int32"/> that determines the first value of the <see langword="for"/> loop.
Use <paramref name="param2"/> to assign the last value.
</param>
<param name="param2">
An <see cref="T:System.Int32"/> that determines the last value of the <see langword="for"/> loop.
Use <paramref name="param1"/> to assign the first value.
</param>
<remarks>
For more information see <see href="https://msdn.microsoft.com/en-us/library/5kzh1b5w.aspx"/>
</remarks>
<seealso href="https://msdn.microsoft.com/en-us/library/5kzh1b5w.aspx"/>
</member>
Código Fuente
➢
Versión 1.3Notas:
La extensión ha sido desarrollada con la
SDK de
Visual Studio 2013, obviamente es necesario disponer de las referencias de dicha
SDK para editar el proyecto.
➢
Microsoft Visual Studio 2013 SDKDescarga el instalador de la extensión (paquete VSIX)
Versión 1.0
➢ Para Visual Studio 2013
➢ (EXPERIMENTAL) Para Visual Studio 2010, 2012, o 2015Versión 1.1
➢ Para Visual Studio 2013
➢ (EXPERIMENTAL) Para Visual Studio 2010, 2012, o 2015Versión 1.3
➢
Para Visual Studio 2010, 2012, 2013 y 2015Observaciones
Las combinaciones del teclado se pueden presionar desde cualquier editor, por ejemplo desde el explorador de soluciones, esto no es una mejora, sino un fallo de diseño que se intentaré solucionar en futuras versiones.Si encuentran cualquier bug no duden en comunicármelo preferiblemente
DEJANDO UN COMENTARIO EN ESTE POST en lugar de enviarme un email o mensaje privado, y trataré de solucionar el problema.
También estoy abierto a sugerencias para implementar nuevas funcionalidades en la extensión, pero no voy a añadirle cosas típicas cómo por ejemplo soporte para insertar sumarios, ya que para eso está
Ghost Doc (u otras extensiones).
Espero que les haya servido y gustado este aporte.
Un saludo!
Mostrar Temas
.
