Xml文档<代码>标签显示 VB.NET 代码的 C#

发布于 2024-11-26 21:38:27 字数 199 浏览 0 评论 0 原文

我正在尝试使用 内的标签标签以显示 xml 文档中的示例代码。但是,当我构建 Sandcastle 项目时,我看到它显示为 C#。 中没有语言属性标签。我在 Sandcastle 的项目属性中找不到设置。我错过了什么吗?

顺便说一句,我使用的是 HtmlHelp1 格式。

I am trying to use the <code> tag inside the <example> tag to show a sample code in xml documentation. However, when I build the Sandcastle project, I see that it is shown as C#. There is no language attribute in <code> tag. And I could not find a setting in Sandcastle's project properties. Am I missing something?

BTW, I am using HtmlHelp1 format.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

っ左 2024-12-03 21:38:27

实际上,如果您从 Sandcastle 转向 Sandcastle 帮助文件生成器 (SHFB),
您将获得更易于使用的 Sandcastle 界面您的文档集的附加功能,包括您想要的:语言属性(语言) 用于 元素。

请注意,SHFB 会生成一个语言选择器菜单,但这仅允许您
显示或隐藏一组特定的语言(C#、VB.NET、C++、J#、JScript.NET、XAML 和 JavaScript)。不过,它支持更大的集合(C#、VB.NET、JScript.NET、C++、J#、C、JavaScript、VBScript、XAML、XML、HTML、SQL 脚本、PowerShell 脚本和 Python)的着色。 (摘自代码块组件部分SHFB 文档。)

我已经就这一点以及 Sandcastle 和 SHFB 的许多其他技巧和陷阱撰写了大量文章,我的文章 Taming Sandcastle:.NET 程序员文档化代码指南发布在 Simple-Talk.com 上。除了主要文章之外,我还整理了 挂图/快速参考,为您提供在一页上使用 Sandcastle/SHFB 所需的一切信息 - 该链接也出现在文章末尾。

您可以在 显示示例代码 我的文章部分,以及来自 从源文件导入代码并对其进行着色

Actually, if you move beyond Sandcastle to Sandcastle Help File Builder (SHFB),
you will get both an easier to use interface to Sandcastle and additional features for your documentation set, including just what you want: a language attribute (language) for the <code> element.

Note that SHFB generates a language selector menu but that only lets you
show or hide a particular set of languages (C#, VB.NET, C++, J#, JScript.NET, XAML, and JavaScript). It supports colorizing, though, of a larger set (C#, VB.NET, JScript.NET, C++, J#, C, JavaScript, VBScript, XAML, XML, HTML, SQL script, PowerShell script, and Python). (From the Code Block Component section of the SHFB documentation.)

I have written extensively on this point, as well as many other tips and pitfalls of Sandcastle and SHFB, in my article Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code published on Simple-Talk.com. Besides the main article, I also put together a wallchart/quick reference that gives you everything you need to know to use Sandcastle/SHFB on one page--the link also appears at the end of the article.

You can find more details about the <code> element in the Displaying Sample Code section of my article, as well as from the official SHFB documentation at Importing and Colorizing Code from Source Files.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文