CodeComment.DocComment 屬性

定義

取得或設定數值,表示註解是否為文件註解。Gets or sets a value that indicates whether the comment is a documentation comment.

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,否則為 falsetrue if the comment is a documentation comment; otherwise, false.

備註

有些語言支援特殊類型的批註, 可以從原始程式碼自動解壓縮以供檔之用。Some languages support a special type of comment that can be automatically extracted from the source code for documentation purposes. 這個屬性可以用來指定批註是否為檔批註, 這可能會產生不同的語法。This property can be used to designate whether the comment is a documentation comment, which may generate a different syntax. 其中一個範例是, C#它會使用 "//" 做為一般批註, 將 "///" 用於檔批註。An example of this is C#, which uses "//" for regular comments and "///" for documentation comments.

適用於