CompilerServices.TypeProviderXmlDocAttribute Class (F#)

The TypeProviderXmlDocAttribute attribute can be added to types and members. The language service will display the CommentText property from the attribute in the appropriate place when the user performs either of the following steps:

  • Points to a type or member in the Visual Studio editor.

  • Moves the cursor so that it appears next to or within the name of a type or member and then chooses the Ctrl+K, I keys.

Namespace/Module Path: Microsoft.FSharp.Core.CompilerServices

Assembly: FSharp.Core (in FSharp.Core.dll)

[<AttributeUsage(32767, AllowMultiple = false)>]
type TypeProviderXmlDocAttribute =
 class
  new TypeProviderXmlDocAttribute : string -> TypeProviderXmlDocAttribute
  member this.CommentText : string
 end

You can also use the short form of the name, TypeProviderXmlDoc.

Member

Description

new

Creates an instance of the attribute.

Member

Description

CommentText

The text that describes the generated type or member.

Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

F# Core Library Versions

Supported in: 4.0, Portable

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft