如何在xml注释的<code>标签中指定语言

Question

如何在xml注释的<code>标签中指定语言

7

有没有一种方法可以在 XML 注释中使用的 <example> 标签中的 <code> 标签中指定所使用的语言？

我正在使用 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>

- Amanda Kitson

如果你还不知道，http://msdn.microsoft.com/en-us/library/5ast78ax.aspx 似乎是关于 XML 的文档。无论是 code 还是 example 都没有任何设置语言的选项，所以我怀疑你可能运气不好。 :( - Chris

是的，我在那里找了一下，但没有看到。我试图弄清楚MSDN如何为不同的编程语言制作示例。 - Amanda Kitson

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Daniel Hilgarth · Accepted Answer

Sandcastle Help File Builder（沙堡帮助文件生成器）扩展了代码标记并支持lang属性。