VCCodeNamespace.DocComment Property
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the document comment for the current code model element.
public:
property System::String ^ DocComment { System::String ^ get(); void set(System::String ^ value); };C++/CX
public:
property Platform::String ^ DocComment { Platform::String ^ get(); void set(Platform::String ^ value); };[System.Runtime.InteropServices.DispId(35)]
public string DocComment { [System.Runtime.InteropServices.DispId(35)] [System.Runtime.InteropServices.TypeLibFunc(System.Runtime.InteropServices.TypeLibFuncFlags.FNonBrowsable)] get; [System.Runtime.InteropServices.DispId(35)] [System.Runtime.InteropServices.TypeLibFunc(System.Runtime.InteropServices.TypeLibFuncFlags.FNonBrowsable)] set; }[<System.Runtime.InteropServices.DispId(35)>]
[<get: System.Runtime.InteropServices.DispId(35)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(System.Runtime.InteropServices.TypeLibFuncFlags.FNonBrowsable)>]
[<set: System.Runtime.InteropServices.DispId(35)>]
[<set: System.Runtime.InteropServices.TypeLibFunc(System.Runtime.InteropServices.TypeLibFuncFlags.FNonBrowsable)>]
member this.DocComment : string with get, setPublic Property DocComment As StringThe document comment for the current code model element.
- Attributes
DocComment returns the special documentation comment or attribute if there is one in the code. If the language implementing the code model does not have a documentation comment mechanism, or if there is none associated with the code element, then DocComment returns an empty string.
Notiz
This property is read-only for code elements from Visual Basic source code.
| Produkt | Versiounen |
|---|---|
| Visual Studio SDK | 2015, 2017, 2019, 2022 |