CodeComment.DocComment Propriedade

Definição

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Pacote:

System.CodeDom v8.0.0

Origem:

CodeComment.cs

Obtém ou define um valor que indica se o comentário é um comentário de documentação.

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

Valor da propriedade

Boolean

true se o comentário for um comentário de documentação; caso contrário, false.

Comentários

Alguns idiomas dão suporte a um tipo especial de comentário que pode ser extraído automaticamente do código-fonte para fins de documentação. Essa propriedade pode ser usada para designar se o comentário é um comentário de documentação, o que pode gerar uma sintaxe diferente. Um exemplo disso é C#, que usa "//" para comentários regulares e "//" para comentários de documentação.