Sandcastle Help File Builderで設定する。
バージョンの違いなのか、他の方の記載している場所が私の環境ではみつからなかった。結局以下の場所にありました。Sandcastle Help File Builder 1.9.7.0
メリット
不要なClassが作成されない。
デメリット
NamespaceだけSandcastle Help File Builderで作成することに違和感がある。
<remark>タグが使えない。
SandcastleでnamespaceにXMLドキュメントのコメントを付ける
http://mag.autumn.org/Content.modf?id=20130610163634
http://dobon.net/vb/bbs/log3-37/22464.html
Sandcastle Help File Builder を開いてプロジェクトを読み込み、または作成したら、ウインドウの右上にある「Namespaces」ボタンをクリックしてみてください。
【環境】
Sandcastle - Version 2.4.10520
Sandcastle Help File Builder 1.7.0.0 Production
--------------
NamespaceDoc Classを作成する。
以下のようなクラスを作成することにより、NamespaceのXmlドキュメントコメントを作成できる。namespace SampleNamespace
{
/// <summary> 概要</summary>
/// <remarks>解説</remarks>
[System.Runtime.CompilerServices.CompilerGeneratedAttribute]
internal class NamespaceDoc
{
}
}
メリット
NamespaceのXmlコメントもソースコードと合わせて管理できる。
<remark>タグも使える。
デメリット
不要なClassが作成される。internalなのでアクセスされることはないが。
Using NamespaceDoc Classes
http://www.ewoodruff.us/shfbdocs/html/48f5a893-acde-4e50-8c17-72b83d9c3f9d.htm
[.NET] SandCastle 用に、 namespace へのコメントをソースコードに埋め込む方法
http://bluewatersoft.cocolog-nifty.com/blog/2008/12/net-sandcastle-.html
0 件のコメント:
コメントを投稿