プログラマーな日々

プログラマーをやっています。好きなものは、C#, TaskChute Cloud, WorkFlowy, Backlog, AWSです。

Sandcastle

Sandcastle Help File Builder が Visual Studio 2012 と .NET Framework 4.5 をサポートしました

Sandcastle Help File Builder が、バージョン1.9.5.0で Visual Studio 2012 と .NET Framework 4.5 をサポートしました。 This new release supports Visual Studio 2010 and 2012 solutions and projects as documentation sources, and adds support for …

Sandcastle Help File Builder v1.9.4.0 with Visual Studio Packageがリリースされました

Sandcastle Help File Builder v1.9.4.0 with Visual Studio Packageがリリースされました。 Sandcastle Help File Builder - Download: SHFB v1.9.4.0 with Visual Studio Package General InformationIMPORTANT: On some systems, the content of the ZIP …

Sandcastle Help File Builder v1.9.3.0 がリリースされました

Sandcastle Help File Builder v1.9.3.0 がリリースされました。 Sandcastle Help File Builder - Download: SHFB v1.9.3.0 ReleaseThis release supports the Sandcastle June 2010 Release (v2.6.10621.1). It includes full support for generating, inst…

XML形式のドキュメントコメントにジェネリック型へのリンクを設定する(その2)

以前実体参照を使ってXMLコメントに""を含める方法を紹介しました。 XML形式のドキュメントコメントにジェネリック型へのリンクを設定する - プログラマーな日々今回はCDATAを使う方法を紹介します。こちらの方が楽で可読性も高いです。 ジェネリック型への…

APIドキュメントを書くなら目を通しておくべき2つのガイド

Sandcastleなどのドキュメント生成ツールが普及し、APIリファレンスを作成するのが当たり前になってきましたが、残念ながら質の低いドキュメントも目にすることも少なくありません。APIリファレンスを改善したい人には、以下を勧めます。 MSDNマガジン MSDN …

XML形式のドキュメントコメントにジェネリック型へのリンクを設定する

XML形式のコメントにジェネリック型へのリンクを設定したいときがあります。 例えば、こんな具合です。 <see cref="System.Collections.Generic.List<T>"/> でもXMLなので「」を記述するとエラーになります。 解決方法 実体参照を使います。こんな具合です。 <see cref="System.Collections.Generic.List&lt;T&gt;"/> サンプルコードも <example> <code> int i = 1; if (i < hoge) { </code></example></see></see>…

Sandcastle Help File Builder 1.9.3.0がリリースされています

Sandcastle Help File Builder 1.9.3.0がリリースされています。Sandcastle Help File Builder - HomeWelcome to the Sandcastle Help File Builder Project ...後で試してみます。

使用例セクションのソースコードに不等号を含める

Sandcastleでヘルプファイルを出力すると、使用例セクションにソースコードを含めることができますが、不等号が含まれていると出力されません。例えばこんなソースコードです。 /// <example> /// <code> if (hoge < 1) { Console.WriteLine("1より小さい") } /// </code> /// </example>不等…

名前空間のドキュメントコメントをSandcastleで出力する

Sandcastleは名前空間のコメントに対応しています。 Using NamespaceDoc ClassesNamespace comments can also be specified and maintained in your source code by adding an empty NamespaceDoc class to each namespace. When comments for this class ar…

SandcastleでHTMLのタグが使えます。

今まで知らなかったのですが、Sandcastleは普通にHTMLのタグが使えます。HTMLヘルプだから当たり前か... コメント タイトルをstrongタグで囲みます。 /// <summary> /// ダミークラスです。 /// </summary> /// <remarks> /// <para><strong>タイトル</strong></para> /// <para>コメント</para> /// </remarks> public class DummyClass { } HT…