Можно ли вставить изображение в код комментария?

Question

Мой вопрос, вероятно, безумная идея, однако он очень ценен, когда я пишу код для образовательных целей.

Особенно, когда код относится к математике и физике, изображения, вставленные в комментарий, более удобны и четко сформулированы.

До сих пор я не могу найти способ успешно вставить истинное изображение в комментарий, а не в C #, Python или любой другой распространенный язык программирования или IDE.

Использование инструментов для преобразования изображения в изображение ASCII - обходной путь с меньшей точностью.

Любая идея ценится

Answer 1

Здесь приведен пример, расширяющий редактор Visual Studio 2010: Вставка изображения (но он привязан к Visual Studio, а не к универсальному решению)

Answer 2

Каждый проект SHFB - это собственный контейнер для всего , видимого в проекте документации.После компиляции XML-документ (проекта программы ") помещается в SHFB для вставки в документ.

Если вы хотите показывать изображения в верхней части документации класса, вы должны добавить изображение впроект SHFB и обратитесь к этому изображению из комментария к коду. См. Проблема 2 ...

Проблема 1:

"Я не могу получитьизображение для отображения из концептуальной темы с использованием тега 'image' "

1. Убедитесь, что используется правильная разметка XML, подобная этой:

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

2. Обратите внимание, что Href (см. Выше) не имеет тип файла , связанный
   , это , потому что Sandcastle хочет идентификатор вместо этого.

3. Добавьте изображение в проект , используя папку мультимедиа по умолчанию . Или, если хотите, вы можете создать свою собственную папку, например, Изображения.
4. Перейти на страницу свойств изображенияи установите Build action в Image . При использовании тега «image» SHFB использует только Image ID находится на странице свойств, приведенной в HREF выше.
5. Перекомпилируйте проект и откройте файл CHM, и вы увидите изображение.

Задача 2:

"Я не могу получить изображение для отображения с использованием разметки кода XML с комментариями в проекте программирования ".

1. В сводном разделе комментария кода разметка может выглядеть следующим образом:

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

2. Обратите внимание, что атрибут src содержит тип файла.Он также должен правильно идентифицировать папку, которая есть в вашем проекте SHFB для этого изображения.

3. После добавления этого изображения в SHFB щелкните его правой кнопкой мыши и измените свойство «Build Action» на Содержимое

Удачного кодирования и документирования!Спасибо Эрику У.

Ключевые слова: SHFB Невозможно добавить изображение Sandcastle Help File Builder Концептуальная тема Изображения Код Комментарий к изображениям Файл CHM Изображения Как добавить изображение в XML Код Комментарий к C #

Answer 3

Инструменты грамотного программирования работают таким образом; вы в основном используете TeX или что-то еще для написания кода, затем запускаете препроцессор, который извлекает фрагменты кода в промежуточный исходный файл. http://en.wikipedia.org/wiki/Literate_programming

Answer 4

Почему бы не использовать бесплатный хостинг изображений, например http://imgur.com, и вставить ссылку на изображение в комментарий к коду?

Тогда единственной проблемой для студента будет копирование ссылки на браузер из любой IDE. Довольно легко, хотя.

Возможно, некоторые IDE имеют возможность "подчеркивать" ссылки, чтобы вы могли щелкнуть по ним вместо копирования.

Answer 5

Я думаю, что вы используете неправильный инструмент для вашей проблемы.IDE - это среда разработки, поэтому не очень важно иметь полный контроль над стилем.

Я бы использовал что-то другое (например, LaTeX, см. Комментарий) для вашей презентации.