Как указать язык в теге xml comment <code> - PullRequest
Новая
       1

Как указать язык в теге xml comment <code>

6 голосов
/ 13 сентября 2011

Есть ли способ указать, какой язык используется в теге <code>, используемом в теге <example> в комментариях XML?

Я использую Sandcastle Help File Builder для тестирования документации по сборке из моих комментариев XML, но когда я включаю примеры кода VB.net в мои разделы примеров, он отображает их как «C #», а не vb.net. Не уверен, что мне нужно что-то еще делать ...

Вот XML-комментарии, которые я пытаюсь сделать. 

        /// <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 emailFrom = "test@test.com";
        /// string emailTo = "recipient@test.com";
        /// string emailBCC = string.empty;
        /// bool isHTML = false;
        /// 
        /// EmailWithComments.SendEmail(subject, emailBody, emailFrom, emailTo, emailBCC, isHTML, null);
        /// </code>
        /// <code>
        /// Dim subject As String = "This is my subject."
        /// Dim emailBody As String() = New From { _
        ///     "body line 1", _
        ///     "body line 2" _
        /// }
        /// Dim emailFrom As String = "test@test.com"
        /// Dim emailTo As String = "recipient@test.com"
        /// Dim emailBCC As String = String.empty
        /// Dim isHTML As Boolean = False
        ///
        /// EmailWithComments.SendEmail(subject, emailBody, emailFrom, emailTo, emailBCC, isHTML, Nothing)
        /// </code>
        /// </example>

1 Ответ

6 голосов
/ 13 сентября 2011

Sandcastle Helpfile Builder расширяет кодовый тег и поддерживает атрибут lang.

...