XML Comments not appearing in WCF Service

Question

I have a WCF service and commenting my operation contracts as below:

    /// <summary>
    /// Call to topup a card.
    /// </summary>
    /// <param name="topUp">The TopUp object which specifies the card to topup.</param>
    /// <returns>Returns a boolean indicating whether call has finished successfully.          </returns>
    [OperationContract]
    bool UploadTopUp(TopUp topUp);

However the XML comments I am putting in the 3 forward slashes as above /// do not appear in the tooltips in my client application that consumes it, is this standard WCF/web service functionality? Will they never appear? OR is there a way to make them appear?

Answer 1

Xml Doc comments are generally not integrated into the generated WSDL for a WCF service. This information is usually only available when the appropriate xml documentation file is co-located with a directly referenced assembly.

The only information that is included in a generated WSDL (or metadata provided by a MEX endpoint) are the properties of the contract attributes themselves. Check the documentation for the following:

• ServiceContract
• OperationContract
• DataContract
• DataMember
• MessageContract
• MessageHeader
• MessageBodyMember
• FaultContract