DoboWiki
Top
> .NETプログラミング研究/36 をテンプレートにして作成
.NETプログラミング研究/36 をテンプレートにして作成
開始行:
#title(.NETプログラミング研究 第36号)
#navi(.NETプログラミング研究)
#contents
*.NETプログラミング研究 第36号 [#fc42d6e3]
**.NET Tips [#pff3f6e8]
***ドキュメントコメントにより型の概要をXMLファイルに出力...
#column(注意){{
この記事の最新版は「[[ドキュメントコメントにより型の概要...
}}
C#のコンパイラには、XML形式のドキュメントコメント(コード...
Visual Studio .NETでは、「スマートコメント編集」と呼ばれ...
#code(csharp){{
public int Plus(int val)
{
}
}}
というメソッドがあったとき、このメソッドの前の空白行で
#pre{{
///
}}
と入力すると、自動的に次のようにドキュメントコメントが挿...
#code(csharp){{
/// <summary>
///
/// </summary>
/// <param name="val"></param>
/// <returns></returns>
public int Plus(int val)
{
}
}}
ここで<summary>タグはメソッドを説明するために使用し、<par...
これ以外にドキュメントコメントで一般的に使用されるXMLタグ...
-[[ドキュメント コメントとして推奨されるタグ>http://www.m...
また、ドキュメントタグの区切り記号としては、
#pre{{
///
}}
の他にも、
#pre{{
/** ... */
}}
で囲む方法もあります。(下の例のTestClassコンストラクタで...
以下にドキュメントコメントを使用した具体的な例を紹介しま...
#code(csharp){{
using System;
namespace ClassLibrary1
{
/// <summary>
/// テストのクラスです。
/// </summary>
/// <exception cref="System.Exception">
/// ここには例外の説明を書きます。
/// </exception>
public class TestClass
{
/// <summary>
/// 現在の合計値を保存するフィールド
/// </summary>
private int _sum;
/// <summary>
/// 現在の合計値を取得設定します。
/// </summary>
/// <value>現在の合計値</value>
public int Sum
{
get {return _sum;}
set {_sum = value;}
}
/// <summary>
/// <c>TestClass</c>クラスの新規インスタンスを初期化し、
/// 指定した数を合計値に設定します。
/// </summary>
/// <param name="val">初期値</param>
public TestClass(int val)
{
_sum = val;
}
/**
<summary>
TestClassクラスの新規インスタンスを初期化します。
</summary>
* アスタリスクで始まる行は無視されます。
*/
public TestClass()
{
_sum = 0;
}
/// <summary>
/// 指定した値を合計値に加算します。
/// </summary>
/// <param name="val">加算する整数</param>
/// <returns>現在の合計値</returns>
/// <remarks>
/// <c>Plus</c>メソッドの
/// <paramref name="val"/>パラメータで加算する整数を指...
/// <para>合計値は<see cref="Sum"/>で
/// 取得できます。</para>
/// </remarks>
/// <example>Plusメソッドの使用コード例です。
/// <code>
/// class MainClass
/// {
/// public static void Main()
/// {
/// TestNP.TestClass tc = new TestNP.TestClass(...
/// tc.Plus(10);
/// }
/// }
/// </code>
/// </example>
/// <seealso cref="System.Int32">Int32構造体</seealso>
/// <seealso cref="Minus"/>
/// <permission cref="System.Security.PermissionSet">
/// このメソッドへは誰でもアクセスできます。</permission>
public int Plus(int val)
{
_sum += val;
return _sum;
}
/// <include file='include.xml'
/// path='TestDocs/TestMembers[@name="Minus"]/*' />
public int Minus(int val)
{
_sum -= val;
return _sum;
}
}
}
}}
上のコードではMinusメソッドにincludeタグを使用しているた...
#code(xml){{
<?xml version="1.0" encoding="utf-8" ?>
<TestDocs>
<TestMembers name="Minus">
<summary>
指定した値を合計値から除算する。
</summary>
<param name="val">除算する値。</param>
<returns>現在の合計値。</returns>
</TestMembers>
</TestDocs>
}}
XMLドキュメントを出力するには、Visual Studio .NETの場合、...
上のクラスライブラリが生成したXMLドキュメントの内容は次の...
#code(xml){{
<?xml version="1.0"?>
<doc>
<assembly>
<name>ClassLibrary1</name>
</assembly>
<members>
<member name="T:ClassLibrary1.TestClass">
<summary>
テストのクラスです。
</summary>
<exception cref="T:System.Exception">
ここには例外の説明を書きます。
</exception>
</member>
<member name="F:ClassLibrary1.TestClass._sum">
<summary>
現在の合計値を保存するフィールド
</summary>
</member>
<member name="M:ClassLibrary1.TestClass.#ctor(Sys...
<summary>
<c>TestClass</c>クラスの新規インスタンスを初...
指定した数を合計値に設定します。
</summary>
<param name="val">初期値</param>
</member>
<member name="M:ClassLibrary1.TestClass.#ctor">
<summary>
TestClassクラスの新規インスタンスを初期化し...
</summary>
* アスタリスクで始まる行は無視されます。
</member>
<member name="M:ClassLibrary1.TestClass.Plus(Syst...
<summary>
指定した値を合計値に加算します。
</summary>
<param name="val">加算する整数</param>
<returns>現在の合計値</returns>
<remarks>
<c>Plus</c>メソッドの
<paramref name="val"/>パラメータで加算する整...
<para>合計値は<see cref="P:ClassLibrary1.Test...
取得できます。</para>
</remarks>
<example>Plusメソッドの使用コード例です。
<code>
class MainClass
{
public static void Main()
{
TestNP.TestClass tc = new TestNP.Test...
tc.Plus(10);
}
}
</code>
</example>
<seealso cref="T:System.Int32">Int32構造体</s...
<seealso cref="M:ClassLibrary1.TestClass.Minu...
<permission cref="T:System.Security.Permissio...
このメソッドへは誰でもアクセスできます。</per...
</member>
<member name="M:ClassLibrary1.TestClass.Minus(Sys...
<summary>
指定した値を合計値から除算する。
</summary><param name="val">除算する値。</param>
<returns>現在の合計値。</returns>
</member>
<member name="P:ClassLibrary1.TestClass.Sum">
<summary>
現在の合計値を取得設定します。
</summary>
<value>現在の合計値</value>
</member>
</members>
</doc>
}}
参考:
-[[XML ドキュメントのチュートリアル>http://www.microsoft....
-[[XML ドキュメント>http://www.microsoft.com/japan/msdn/l...
C#では以上のような機能をコンパイラが提供していますが、VB....
-[[Developer PowerToys>http://www.gotdotnet.com/team/ide/]]
-[[VBCommenter Help>http://www.gotdotnet.com/team/ide/hel...
-[[VBCommenter Help ダウンロード>http://www.gotdotnet.com...
VBCommenter HelpはVisual Studio .NETのアドオンのため、Vis...
デフォルトでは、例えば次のようなメソッドがあったとき、
#code(vbnet){{
Public Function Plus(ByVal val As Integer) As Integer
End Function
}}
この前の行で
#pre{{
'''
}}
と入力してからEnterキーを押すと、 次のようなコメントが自...
#code(vbnet){{
''' -----------------------------------------------------...
''' <summary>
''' '''
''' </summary>
''' <param name="val"></param>
''' <returns></returns>
''' <remarks>
''' </remarks>
''' <history>
''' [Administrator] 2004/XX/XX Created
''' </history>
''' -----------------------------------------------------...
Public Function Plus(ByVal val As Integer) As Integer
End Function
}}
つまり、
#pre{{
///
}}
の代わりに
#pre{{
'''
}}
を先頭に書いて、C#の時と同様にドキュメントコメントを記述...
デフォルトでは、プロジェクトをビルドすると自動的にXMLファ...
VBCommenter Helpと同様のアプリケーションにはさらに「VB.DO...
-[[VB.DOC>http://vb-doc.sourceforge.net/]]
-[[VBXC - VB.NET XML Commentor>http://vbxmldoc.tor-erik.n...
さらに、アセンブリのXMLドキュメントファイルを作成、編集す...
-[[XML Documentation Tool>http://www.gotdotnet.com/team/v...
-[[101 Visual Basic and C# Code Samples>http://www.micros...
上記のように作成されたXMLファイルですが、このままでは非常...
-[[Introducing the Visual Studio .NET Lab Series>http://m...
-[[Lab 2: XML Comments>http://msdn.microsoft.com/library/...
「Lab 2: XML Comments」の方法をごく簡単に説明します(詳し...
#pre{{
<?xml version="1.0"?>
}}
と
#pre{{
<doc>
}}
の間に
#pre{{
<?xml-stylesheet href="doc.xsl" type="text/xsl"?>
}}
を書き足して、おしまいです。こうしてできたXMLファイル("do...
-[[doc.xsl>https://dobon.net/vb/dotnet/programing/xmldocu...
-[[doc.xml>https://dobon.net/vb/dotnet/programing/xmldocu...
さらにツールを使って見やすいHTMLファイルを生成する方法を...
***コードコメントWebレポートを作成する / ドキュメントコメ...
#column(注意){{
この記事の最新版は「[[自作したクラスライブラリのヘルプ(...
}}
「コードコメントWebレポート」とは、プロジェクトで定義され...
コードコメントWebレポートは、先に紹介したドキュメントコメ...
論より証拠、実際どのようなレポートが出力されるのか、見て...
先ほどと同じクラスライブラリを作成し、このコードコメントW...
このようにして実際に作成されたコードコメントWebレポートは...
-[[ClassLibrary1 の コード コメント Web レポート>https://...
参考:
-[[コード レポートの作成>http://www.microsoft.com/japan/m...
コードコメントWebレポートと同様のツールに、「NDoc」があり...
-[[NDoc>http://sourceforge.net/projects/ndoc/]]
-[[NDoc日本語版>http://sourceforge.jp/projects/ndoc-jp/]]
NDocは先に紹介したXMLドキュメントが必要になりますので、ND...
NDoc Ver 1.3-beta1aと日本語版 Ver 0.1のデフォルトの設定で...
-[[An NDoc Documented Class Library>https://dobon.net/vb/...
-[[An NDoc Documented Class Library(日本語版)>https://d...
さらに、ヘルプファイルの作成は、「Developer PowerToys」の...
-[[Developer PowerToys>http://www.gotdotnet.com/team/ide/]]
-[[Custom Help Builder>http://www.gotdotnet.com/team/ide/...
-[[Custom Help Builder ダウンロード>http://www.gotdotnet....
***IntelliSenseで自作クラスのメンバの説明を表示する [#zfa...
#column(注意){{
この記事の最新版は「[[IntelliSenseで自作クラスのメンバの...
}}
Visual Studio .NETの機能であるIntelliSenseのクイックヒン...
また、クラスライブラリなどのアセンブリを参照して使用する...
**コンピュータ雑学 [#v22b10f1]
ここでは、話すと人に嫌われるなまぬるいコンピュータに関す...
***「C++」の「++」の意味は? [#i89f478d]
C++言語は、1983〜1985年にAT&Tベル研究所のストラウストラッ...
-[[Bjarne Stroustrup's Homepage>http://www.research.att.c...
ちなみに、「C#」の「#」は「C++」のインクリメンタル演算子...
#code(csharp){{
using System;
class MainClass
{
public static void Main()
{
int C = 0;
C++;
C#;
Console.WriteLine(C);
}
}
}}
しかし残念ながら(当たり前ですが)、コンパイルエラーがで...
**コメント [#z9de2a3c]
#comment
//これより下は編集しないでください
#pageinfo([[:Category/.NET]],2004-06-28 (月) 06:00:00,DOB...
終了行:
#title(.NETプログラミング研究 第36号)
#navi(.NETプログラミング研究)
#contents
*.NETプログラミング研究 第36号 [#fc42d6e3]
**.NET Tips [#pff3f6e8]
***ドキュメントコメントにより型の概要をXMLファイルに出力...
#column(注意){{
この記事の最新版は「[[ドキュメントコメントにより型の概要...
}}
C#のコンパイラには、XML形式のドキュメントコメント(コード...
Visual Studio .NETでは、「スマートコメント編集」と呼ばれ...
#code(csharp){{
public int Plus(int val)
{
}
}}
というメソッドがあったとき、このメソッドの前の空白行で
#pre{{
///
}}
と入力すると、自動的に次のようにドキュメントコメントが挿...
#code(csharp){{
/// <summary>
///
/// </summary>
/// <param name="val"></param>
/// <returns></returns>
public int Plus(int val)
{
}
}}
ここで<summary>タグはメソッドを説明するために使用し、<par...
これ以外にドキュメントコメントで一般的に使用されるXMLタグ...
-[[ドキュメント コメントとして推奨されるタグ>http://www.m...
また、ドキュメントタグの区切り記号としては、
#pre{{
///
}}
の他にも、
#pre{{
/** ... */
}}
で囲む方法もあります。(下の例のTestClassコンストラクタで...
以下にドキュメントコメントを使用した具体的な例を紹介しま...
#code(csharp){{
using System;
namespace ClassLibrary1
{
/// <summary>
/// テストのクラスです。
/// </summary>
/// <exception cref="System.Exception">
/// ここには例外の説明を書きます。
/// </exception>
public class TestClass
{
/// <summary>
/// 現在の合計値を保存するフィールド
/// </summary>
private int _sum;
/// <summary>
/// 現在の合計値を取得設定します。
/// </summary>
/// <value>現在の合計値</value>
public int Sum
{
get {return _sum;}
set {_sum = value;}
}
/// <summary>
/// <c>TestClass</c>クラスの新規インスタンスを初期化し、
/// 指定した数を合計値に設定します。
/// </summary>
/// <param name="val">初期値</param>
public TestClass(int val)
{
_sum = val;
}
/**
<summary>
TestClassクラスの新規インスタンスを初期化します。
</summary>
* アスタリスクで始まる行は無視されます。
*/
public TestClass()
{
_sum = 0;
}
/// <summary>
/// 指定した値を合計値に加算します。
/// </summary>
/// <param name="val">加算する整数</param>
/// <returns>現在の合計値</returns>
/// <remarks>
/// <c>Plus</c>メソッドの
/// <paramref name="val"/>パラメータで加算する整数を指...
/// <para>合計値は<see cref="Sum"/>で
/// 取得できます。</para>
/// </remarks>
/// <example>Plusメソッドの使用コード例です。
/// <code>
/// class MainClass
/// {
/// public static void Main()
/// {
/// TestNP.TestClass tc = new TestNP.TestClass(...
/// tc.Plus(10);
/// }
/// }
/// </code>
/// </example>
/// <seealso cref="System.Int32">Int32構造体</seealso>
/// <seealso cref="Minus"/>
/// <permission cref="System.Security.PermissionSet">
/// このメソッドへは誰でもアクセスできます。</permission>
public int Plus(int val)
{
_sum += val;
return _sum;
}
/// <include file='include.xml'
/// path='TestDocs/TestMembers[@name="Minus"]/*' />
public int Minus(int val)
{
_sum -= val;
return _sum;
}
}
}
}}
上のコードではMinusメソッドにincludeタグを使用しているた...
#code(xml){{
<?xml version="1.0" encoding="utf-8" ?>
<TestDocs>
<TestMembers name="Minus">
<summary>
指定した値を合計値から除算する。
</summary>
<param name="val">除算する値。</param>
<returns>現在の合計値。</returns>
</TestMembers>
</TestDocs>
}}
XMLドキュメントを出力するには、Visual Studio .NETの場合、...
上のクラスライブラリが生成したXMLドキュメントの内容は次の...
#code(xml){{
<?xml version="1.0"?>
<doc>
<assembly>
<name>ClassLibrary1</name>
</assembly>
<members>
<member name="T:ClassLibrary1.TestClass">
<summary>
テストのクラスです。
</summary>
<exception cref="T:System.Exception">
ここには例外の説明を書きます。
</exception>
</member>
<member name="F:ClassLibrary1.TestClass._sum">
<summary>
現在の合計値を保存するフィールド
</summary>
</member>
<member name="M:ClassLibrary1.TestClass.#ctor(Sys...
<summary>
<c>TestClass</c>クラスの新規インスタンスを初...
指定した数を合計値に設定します。
</summary>
<param name="val">初期値</param>
</member>
<member name="M:ClassLibrary1.TestClass.#ctor">
<summary>
TestClassクラスの新規インスタンスを初期化し...
</summary>
* アスタリスクで始まる行は無視されます。
</member>
<member name="M:ClassLibrary1.TestClass.Plus(Syst...
<summary>
指定した値を合計値に加算します。
</summary>
<param name="val">加算する整数</param>
<returns>現在の合計値</returns>
<remarks>
<c>Plus</c>メソッドの
<paramref name="val"/>パラメータで加算する整...
<para>合計値は<see cref="P:ClassLibrary1.Test...
取得できます。</para>
</remarks>
<example>Plusメソッドの使用コード例です。
<code>
class MainClass
{
public static void Main()
{
TestNP.TestClass tc = new TestNP.Test...
tc.Plus(10);
}
}
</code>
</example>
<seealso cref="T:System.Int32">Int32構造体</s...
<seealso cref="M:ClassLibrary1.TestClass.Minu...
<permission cref="T:System.Security.Permissio...
このメソッドへは誰でもアクセスできます。</per...
</member>
<member name="M:ClassLibrary1.TestClass.Minus(Sys...
<summary>
指定した値を合計値から除算する。
</summary><param name="val">除算する値。</param>
<returns>現在の合計値。</returns>
</member>
<member name="P:ClassLibrary1.TestClass.Sum">
<summary>
現在の合計値を取得設定します。
</summary>
<value>現在の合計値</value>
</member>
</members>
</doc>
}}
参考:
-[[XML ドキュメントのチュートリアル>http://www.microsoft....
-[[XML ドキュメント>http://www.microsoft.com/japan/msdn/l...
C#では以上のような機能をコンパイラが提供していますが、VB....
-[[Developer PowerToys>http://www.gotdotnet.com/team/ide/]]
-[[VBCommenter Help>http://www.gotdotnet.com/team/ide/hel...
-[[VBCommenter Help ダウンロード>http://www.gotdotnet.com...
VBCommenter HelpはVisual Studio .NETのアドオンのため、Vis...
デフォルトでは、例えば次のようなメソッドがあったとき、
#code(vbnet){{
Public Function Plus(ByVal val As Integer) As Integer
End Function
}}
この前の行で
#pre{{
'''
}}
と入力してからEnterキーを押すと、 次のようなコメントが自...
#code(vbnet){{
''' -----------------------------------------------------...
''' <summary>
''' '''
''' </summary>
''' <param name="val"></param>
''' <returns></returns>
''' <remarks>
''' </remarks>
''' <history>
''' [Administrator] 2004/XX/XX Created
''' </history>
''' -----------------------------------------------------...
Public Function Plus(ByVal val As Integer) As Integer
End Function
}}
つまり、
#pre{{
///
}}
の代わりに
#pre{{
'''
}}
を先頭に書いて、C#の時と同様にドキュメントコメントを記述...
デフォルトでは、プロジェクトをビルドすると自動的にXMLファ...
VBCommenter Helpと同様のアプリケーションにはさらに「VB.DO...
-[[VB.DOC>http://vb-doc.sourceforge.net/]]
-[[VBXC - VB.NET XML Commentor>http://vbxmldoc.tor-erik.n...
さらに、アセンブリのXMLドキュメントファイルを作成、編集す...
-[[XML Documentation Tool>http://www.gotdotnet.com/team/v...
-[[101 Visual Basic and C# Code Samples>http://www.micros...
上記のように作成されたXMLファイルですが、このままでは非常...
-[[Introducing the Visual Studio .NET Lab Series>http://m...
-[[Lab 2: XML Comments>http://msdn.microsoft.com/library/...
「Lab 2: XML Comments」の方法をごく簡単に説明します(詳し...
#pre{{
<?xml version="1.0"?>
}}
と
#pre{{
<doc>
}}
の間に
#pre{{
<?xml-stylesheet href="doc.xsl" type="text/xsl"?>
}}
を書き足して、おしまいです。こうしてできたXMLファイル("do...
-[[doc.xsl>https://dobon.net/vb/dotnet/programing/xmldocu...
-[[doc.xml>https://dobon.net/vb/dotnet/programing/xmldocu...
さらにツールを使って見やすいHTMLファイルを生成する方法を...
***コードコメントWebレポートを作成する / ドキュメントコメ...
#column(注意){{
この記事の最新版は「[[自作したクラスライブラリのヘルプ(...
}}
「コードコメントWebレポート」とは、プロジェクトで定義され...
コードコメントWebレポートは、先に紹介したドキュメントコメ...
論より証拠、実際どのようなレポートが出力されるのか、見て...
先ほどと同じクラスライブラリを作成し、このコードコメントW...
このようにして実際に作成されたコードコメントWebレポートは...
-[[ClassLibrary1 の コード コメント Web レポート>https://...
参考:
-[[コード レポートの作成>http://www.microsoft.com/japan/m...
コードコメントWebレポートと同様のツールに、「NDoc」があり...
-[[NDoc>http://sourceforge.net/projects/ndoc/]]
-[[NDoc日本語版>http://sourceforge.jp/projects/ndoc-jp/]]
NDocは先に紹介したXMLドキュメントが必要になりますので、ND...
NDoc Ver 1.3-beta1aと日本語版 Ver 0.1のデフォルトの設定で...
-[[An NDoc Documented Class Library>https://dobon.net/vb/...
-[[An NDoc Documented Class Library(日本語版)>https://d...
さらに、ヘルプファイルの作成は、「Developer PowerToys」の...
-[[Developer PowerToys>http://www.gotdotnet.com/team/ide/]]
-[[Custom Help Builder>http://www.gotdotnet.com/team/ide/...
-[[Custom Help Builder ダウンロード>http://www.gotdotnet....
***IntelliSenseで自作クラスのメンバの説明を表示する [#zfa...
#column(注意){{
この記事の最新版は「[[IntelliSenseで自作クラスのメンバの...
}}
Visual Studio .NETの機能であるIntelliSenseのクイックヒン...
また、クラスライブラリなどのアセンブリを参照して使用する...
**コンピュータ雑学 [#v22b10f1]
ここでは、話すと人に嫌われるなまぬるいコンピュータに関す...
***「C++」の「++」の意味は? [#i89f478d]
C++言語は、1983〜1985年にAT&Tベル研究所のストラウストラッ...
-[[Bjarne Stroustrup's Homepage>http://www.research.att.c...
ちなみに、「C#」の「#」は「C++」のインクリメンタル演算子...
#code(csharp){{
using System;
class MainClass
{
public static void Main()
{
int C = 0;
C++;
C#;
Console.WriteLine(C);
}
}
}}
しかし残念ながら(当たり前ですが)、コンパイルエラーがで...
**コメント [#z9de2a3c]
#comment
//これより下は編集しないでください
#pageinfo([[:Category/.NET]],2004-06-28 (月) 06:00:00,DOB...
ページ名:
▲
▼
[
トップ
] [
新規
|
子ページ作成
|
一覧
|
単語検索
|
最終更新
|
ヘルプ
]