CodeComment.DocComment プロパティ

定義

名前空間:

System.CodeDom

アセンブリ:

System.CodeDom.dll

パッケージ:

System.CodeDom v8.0.0

ソース:

CodeComment.cs

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

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

public bool DocComment { get; set; }

member this.DocComment : bool with get, set

Public Property DocComment As Boolean

プロパティ値

Boolean

コメントがドキュメント コメントの場合は true。それ以外の場合は false。

注釈

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