コードコメントに画像を挿入することは可能ですか？

Question

私の質問はおそらく非常識な考えですが、教育目的のコードを書くときは非常に貴重です。

特に、コードが数学および物理学の主題に関連する場合、コメントに挿入された画像は、より便利で明瞭になります。

これまで、私はコメントに真のイメージを挿入する方法が見つからず、C＃、Python、またはその他の一般的なプログラミング言語やIDEではありません。

画像をASCII画像に変換するツールを使用すると、精度が低下する可能性があります。

任意のアイデアは、私はあなたがあなたの問題のために間違ったツールを使用していると思う

Answer 1

：Image Insertionは

Answer 2

に感謝です。 IDEは「開発」環境であるため、スタイリングを完全に制御することはあまり重要ではありません。

プレゼンテーションには別のもの（LaTeXのように、コメントを参照）を使用します。 Visual Studio 2010のエディタ拡張ここに例があり

Answer 3

文芸的プログラミングツールは、このように動作します（ただし、それは、Visual Studioのではなく、汎用的な解決に結びついています）。基本的にTeXなどを使ってコードを書いてから、コードスニペットを中間ソースファイルに抽出するプリプロセッサを実行します。 http://en.wikipedia.org/wiki/Literate_programming

Answer 4

なぜhttp://imgur.comのような無料の画像ホスティングを使用して、コードのコメントを挿入するのはいいですか？

学生にとって唯一の問題は、IDEからブラウザへのリンクをコピーすることだけです。しかし、かなり簡単です。

ある種のIDEには、リンクを「アンダーライン」する機能があり、コピペアの代わりにクリックすることができます。

Answer 5

各SHFBプロジェクトは、のすべてのドキュメント用プロジェクトに表示されている用の独自のコンテナです。

イメージをクラスドキュメントの最上部に表示するには、イメージをSHFBに追加する必要があります（イメージをSHFBに追加する必要があります）。このプロジェクトは、コードのコメントからその画像を参照してください。問題2 ...

問題1を参照してください：。

「私は 『イメージ』を使用して、概念的なトピックから表示する画像を取得することはできませんがタグ "

1. これに似た適切なXMLマークアップを使用してください：Hrefの（上記の）は、関連するファイルの種類を持っていないことを

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

2. お知らせを、
   サンドキャッスルが望んでいるので、これはです代わりにIDが必要です。

3. デフォルトメディアフォルダを使用して、画像をプロジェクトに追加します。または、必要に応じて、イメージなどの独自のフォルダを作成することもできます。
4. イメージのプロパティページに移動し、ビルドアクションをイメージに設定します。 "image"タグを使用すると、SHFBは上記のHREFにあるプロパティページにあるImage IDしか使用しません。
5. プロジェクトを再コンパイルし、CHMファイルを開くと、 イメージが表示されます。

は問題2：

「私は、プログラミングプロジェクトにXMLマークアップをコメントコードを使用して表示する画像を得ることができません」。コードのコメントの要約セクションで

1. 、マークアップは のように、これを見ることができます：

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

2. src属性は、ファイルの種類を含まれないことに注意してください。また、SHFBプロジェクトがそのイメージに対して持っているフォルダを正しく識別する必要があります。その上で右クリックして、コンテンツ

ハッピー符号化と文書化に「ビルドアクション」プロパティを変更SHFBにその画像を追加した後

！ おかげでエリックW.に行く

キーワード： SHFBイメージを追加することはできません サンドキャッスルのヘルプは、C＃