misc.log

日常茶飯事とお仕事と

ドキュメントコメントの「code」タグを使うとタイトルが「C#」になる

Visual Studio 2010などにある、定型書式のコメントからヘルプを作る機能で、サンプルコードを埋め込むタグ「code」を使うと、なぜかサンプルコード部分のタイトルが「C#」になってしまうという問題がずっと出ていました(下図参照)。

まぁサンプル自体は読めるのでいいと言えばいいのですが、なんせ格好が悪い。というわけでちょっと探したら、SandCastleがタグを拡張して言語とかを指定できるようにしているようです。たとえば、Codeタグは

<code lang="vbnet">

のようにすればSandCastleで処理するときに解釈してVisual Basicというタイトルにしてくれるみたい。他にもXMLなどいろんなサンプルタイトルが用意されているようなので、以下のリンクを参考にしてみてください。

参考

stackovervlow/How to specify language in xml comment code tag
http://stackoverflow.com/questions/7403479/how-to-specify-language-in-xml-comment-code-tag
Sandcastle Help File Builder Documentation/Code Block Component
http://www.ewoodruff.us/shfbdocs/html/7f03ba39-09f8-4320-bdbd-ed31a3bd885f.htm


エンジニアのためのWord再入門講座 美しくメンテナンス性の高い開発ドキュメントの作り方

エンジニアのためのWord再入門講座 美しくメンテナンス性の高い開発ドキュメントの作り方