CodeComment.DocComment 属性

定义

命名空间:

System.CodeDom

程序集:

System.CodeDom.dll

包:

System.CodeDom v8.0.0

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#，它使用“//”作为常规注释，使用“///”作为文档注释。