CodeComment.DocComment Свойство
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает или задает значение, указывающее, является ли комментарий комментарием документации.
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
Значение свойства
true Значение , если комментарий является комментарием документации; falseв противном случае .
Комментарии
Некоторые языки поддерживают специальный тип комментариев, которые можно автоматически извлечь из исходного кода в целях документации. Это свойство можно использовать для обозначения того, является ли комментарий комментарием документации, который может создать другой синтаксис. Примером этого является C#, который использует "/" для регулярных комментариев и "//" для комментариев документации.