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#, который использует "//" для обычных комментариев и "///" для комментариев к документации.