¿Es posible insertar imagen en un comentario de código?

Question

Mi pregunta es probablemente una idea insensata, sin embargo, es muy valiosa cuando escribo código con fines educativos.

Especialmente cuando el código es relevante para el tema de matemáticas y física, las imágenes insertadas en el comentario son más convenientes y articuladas.

Hasta ahora, no puedo encontrar una manera de tener éxito para insertar una imagen verdadera en el comentario, no C# ni Python o cualquier otro lenguaje de programación común o IDEs.

El uso de herramientas que convierten imágenes en imágenes ASCII es una solución con menos precisión.

Cualquier idea es apreciar

Answer 1

Hay un ejemplo aquí que se extienden del editor de Visual Studio 2010: Image Insertion (pero está ligada a Visual Studio, no es una solución genérica)

Answer 2

Creo que está utilizando la herramienta equivocada para su problema. Un IDE es un entorno de "desarrollo", por lo que no es muy importante tener un control total sobre el diseño.

Me gustaría utilizar algo más (como LaTeX, ver el comentario) para su presentación.

Answer 3

herramientas de programación literaria funcionan de esta manera; básicamente utiliza TeX o algo para escribir el código, luego ejecuta un preprocesador que extrae los fragmentos de código en un archivo fuente intermedio. http://en.wikipedia.org/wiki/Literate_programming

Answer 4

¿Por qué no utilizar un alojamiento de imágenes gratuito como http://imgur.com e insertar un enlace de imagen al comentario del código?

Entonces el único problema para un estudiante sería copiar el enlace al navegador desde cualquier IDE. Muy fácil sin embargo.

Tal vez algunos IDEs tengan la capacidad de "subrayar" enlaces para que pueda hacer clic en él en lugar de copiar.

Answer 5

Cada proyecto SHFB es su propio contenedor para todo visto en el proyecto de documentación. Cuando se compila, el documento XML (del proyecto del programa) se inserta en SHFB para colocarlo en el documento.

Si desea mostrar imágenes en la sección superior de la documentación de la clase, debe agregar la imagen a la SHFB. proyecto y se refieren a esa imagen del código de comentario Véase el problema 2 ...

Problema 1:.

"no puedo conseguir una imagen para mostrar de un tema conceptual utilizando la 'imagen' etiqueta "

1. Asegúrese de utilizar el marcado XML adecuada similar a esto:

   <section> 
       <content>   
       <mediaLink> 
        <image xlink:href="MyMainImage"/> 
       </mediaLink> 
       </content> 
   </section> 
   

2. en cuenta que la Href (arriba) no tiene el tipo de archivo asociado,
   esto es porque quiere que el castillo de arena ID en su lugar.

3. Agregue la imagen al proyecto utilizando la carpeta multimedia predeterminada. O, si lo desea, puede crear su propia carpeta, por ejemplo, Imágenes.
4. Vaya a la página de propiedades de la imagen y configure la acción de compilación en Imagen. Cuando utiliza una etiqueta de "imagen", SHFB solo usa la con la ID de la imagen que se encuentra en la página de propiedades, que se ve en el HREF anterior.
5. Vuelva a compilar el proyecto y abra el archivo CHM y verá la imagen .

Problema 2:

"No puedo conseguir una imagen para mostrar utilizando código de comentar el formato XML en el proyecto de programación".

1. En la sección Resumen del comentario de código, el marcado puede parecerse a este :

   /// <summary> 
   /// <remarks><img src="\Images\MyImage.PNG"/></remarks> 
   /// </summary> 
   

2. Tenga en cuenta que el atributo src hace contienen el tipo de archivo. También debe identificar correctamente la carpeta que tiene su proyecto SHFB para esa imagen.

3. Después de añadir esa imagen a la SHFB clic derecho sobre él y cambie la propiedad "Acción de generación" a contenido

codificación y documentación feliz! gracias van a Eric W.

Palabras clave: SHFB No puede agregar imagen Sandcastle Archivo de Ayuda Builder conceptuales Tema Imágenes Código Imágenes Comentando CHM archivo Las imágenes ¿Cómo añadir una imagen en código XML Al comentar C#