Alex Rivera | Logout

How to specify language in xml comment <code> tag

Asked 2011-09-13T14:25:01.730
9

Is there a way to specify what language is being used in the <code> tag used within an <example> tag in XML comments?

I am using Sandcastle Help File Builder to test building documentation from my XML comments, but when I include VB.net code samples in my example sections, it displays them as "C#", not vb.net. Not sure if there is something else I need to do...

Here is the XML comments I am trying to make.

        /// <summary>
        /// Creates and sends an email.
        /// </summary>
        /// <param name="subject">A <c>String</c> that contains the subject text.</param>
        /// <param name="emailBody">A <c>String</c> that contains the message body.</param>
        /// <param name="emailFrom">A <c>String</c> that contains the address of the sender of the e-mail message.</param>
        /// <param name="emailTo">A <c>String</c> that contains the addresses of the recipients of the e-mail messa</param>
        /// <param name="emailBCC">The email address to blind carbon-copy the email to.</param>
        /// <param name="IsHtml">if set to <c>true</c> [the body of the email HTML].</param>
        /// <param name="attachment">The <c>System.Net.Mail.Attachment</c> to the email.</param>
        /// <exception cref="ArgumentNullException"><c>emailFrom</c> is null or <c>emailTo</c> is null.</exception>
        /// <exception cref="ArgumentException"><c>emailFrom</c> is <c>Empty</c> ("") or <c>emailTo</c> is <c>Empty</c> ("").</exception>
        /// <example>
        /// <code>
        /// string subject = "This is my subject.";
        /// string[] emailBody = new {"body line 1", "body line 2"};
        /// string email
Edit
Report

1 Answer

8

Sandcastle Help File Builder extends the code tag and supports the lang attribute.

answered 2011-09-13T14:49:50.177

Your Answer