CodeComment.DocComment 属性

定义

命名空间:

System.CodeDom

程序集:

System.CodeDom.dll

包:

System.CodeDom v11.0.0-preview.4.26230.115

Source:

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# 使用“//”进行常规注释，将“//”用于文档注释。