CodeComment.DocComment プロパティ

.NET Framework クラス ライブラリ リファレンス

CodeComment.DocComment プロパティ

コメントがドキュメント コメントかどうかを示す値を取得または設定します。

名前空間: System.CodeDom
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Property DocComment As
 Boolean

Visual Basic (使用法)

Dim instance As CodeComment
Dim value As Boolean

value = instance.DocComment

instance.DocComment = value

C#

public bool DocComment { get;
 set; }

C++

public:
property bool DocComment {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_DocComment ()

/** @property */
public void set_DocComment (boolean value)

JScript

public function get DocComment
 () : boolean

public function set DocComment
 (value : boolean)

プロパティ値
コメントがドキュメント コメントの場合は true。それ以外の場合は false。

解説

言語によっては、ドキュメント作成を目的として、ソース コードから自動的に抽出される特殊な種類のコメントがサポートされています。このプロパティは、コメントがドキュメント コメントかどうかを示すために使用できます。ドキュメント コメントからは、別の構文が生成される可能性があります。たとえば C# では、通常のコメントでは "//" が、ドキュメント コメントでは "///" が使用されます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
CodeComment クラス
CodeComment メンバ
System.CodeDom 名前空間