2011-07-20 15 views
11

this MSDN pageの備考欄の黄色の「注記」ボックスにも同様のことをしたいと思います。C#xml documentation:Notesを作成するには?

私はサンドキャッスルとサンドキャッスルヘルプファイルビルダーを使用して、ドキュメンテーションタグからリファレンスウェブサイトを生成しています。このようなメモボックスを実現するためには何を書かなければならないのですか?

答えて

13
/// <summary><c>Increment</c> method increments the stored number by one. 
/// <note type="caution"> 
/// note description here 
/// </note> 
/// </summary> 

ルック

  • ノート
  • 先端
  • ます。 "C:\ Program Files \サンドキャッスル\例\サンドキャッスル\ test.cs"

    タイプのいずれかになります

  • 注意
  • セキュリティ
  • 重要
  • VB/VB/VisualBasicの/ビジュアルベーシックノート
  • CS/CSHARP/C#/ C#/ビジュアルC#ノート
  • CPP/C++/C++/CPP /のVisual C++ノート
  • 視覚的JSharp/jは#/ J#/ J#注意
  • 、発信者
+0

クール。それだけで動作します!タグは「公式」リストには見つかりませんでしたが、NDocタグもサポートされていることを知っておいてください。 –

+0

はい。正式にはサポートされていませんが、SandCastleはNDocで正確に触発されました:http://blogs.msdn.com/b/sandcastle/archive/2006/11/22/supporting-custom-tags-in-sandcastle.aspx – chopikadze

+0

THX、私の+1。ちょっとしたこと:普通はを

セクションに含めないでください。 がより適切であるはずです。 –

0

ない直接的な解決策が、代替:

NDoc<note>タグをサポートしています。 NDocは古くなっているので、この機能はNDoc3にあります。asp.netを前提としたオンラインドキュメントだけでなく、プレーンなHTMLドキュメントを作成することもできるので、これは見逃せません。ファイルの

+0

感謝を継承しますが、私たちのインフラはすでにSCに依存し、その簡単に変更することはできません。

  • を実装 –

  • 関連する問題