C#或VB文档注释中的粗体还是斜体?

C#或VB文档注释中的粗体还是斜体?,c#,vb.net,visual-studio-2015,roslyn,C#,Vb.net,Visual Studio 2015,Roslyn,有没有办法在文档注释中使用粗体或斜体?比如: ///清除方法。这是推荐的清理方法。 公共空间清除所有(); 不包含这样的功能,但您知道实现强调/突出显示的某种方法吗?最好是,当鼠标悬停在代码上时,也可以在工具提示中显示 我们有和,但它们已经有了它们的语义。OP的注释:这是2019年Visual Studio更新之前接受的答案,之后我接受了另一个答案。对于没有该更新的用户来说,此版本仍然有用且有效 严格来说,不是。但是,(从文档生成HTML的文档生成器)支持只在其中使用HTML,因此如果使用S

有没有办法在文档注释中使用粗体或斜体?比如:

///清除方法。这是推荐的清理方法。
公共空间清除所有();
不包含这样的功能,但您知道实现强调/突出显示的某种方法吗?最好是,当鼠标悬停在代码上时,也可以在工具提示中显示

我们有
,但它们已经有了它们的语义。

OP的注释:这是2019年Visual Studio更新之前接受的答案,之后我接受了另一个答案。对于没有该更新的用户来说,此版本仍然有用且有效


严格来说,不是。但是,(从文档生成HTML的文档生成器)支持只在其中使用HTML,因此如果使用Sandcastle构建,您可以使用

换句话说:正如前面提到的,XML文档注释就是XML。因此,您可以将任何有效的XML放入其中;编译器将很高兴地将其写入文档XML文件中。这完全取决于处理该文件的软件。Sandcastle只是将它不知道的内容作为HTML传递,因为这是它的输出格式

Visual Studio将在显示帮助工具提示时忽略这些提示:

ReSharper在其Ctrl+Q视图中将HTML标记显示为文本,这会让事情变得有点难看:

不过,通常只有当您编写了一个供他人使用的库时,您才会关心这些问题。但这也意味着在IDE中,没有人能看到您的重点

我发现在编写API文档时,实际上不需要强调什么;通常情况下,你可以用不同的方式写一个句子,也可以调整句子结构,使其在接近结尾的单独段落中有重要的节点,从而完全不需要强调。一致的语言和措辞也有助于读者在习惯了重要的注释后,及时发现它们


您的代码可能只是一个示例,但我认为总结最不需要强调,因为它只在一个简短的句子中说明了类型或方法的作用。如果有的话,在评论中使用它,即使是这样,我也会仔细考虑你是否真的需要它。

< P>另一种方法是使用wiki标记风格,而不是样式。

/// <summary>Cleanup method. This is *recommended* way of cleanup.</summary>
public void CleanAll();
///清除方法。这是推荐的清理方法。
公共空间清除所有();
编辑1:
AFAIK Visual Studio不理解wiki标记。我只是建议使用wiki标记作为惯例。您的团队仍然可以在方法的intellisense中看到原始(未格式化)的wiki标记。

还有其他添加强调的方法:

 - Upper case:    some BOLD text       // you are shouting, but they WILL read it
 - First letter:  some Bold text       // less emphasis
 - Asterisks:     some **bold** text   // 2 asterisks seem to work best
 - Dashes:        some --bold-- text   // less emphasis

纯文本是老生常谈,但它可能非常有效——而且在技术改变后很长一段时间内仍然有效。

当我遇到(请参阅)一个在Intellisense显示屏中添加换行符的功能时,它会(根据文档)在文档中插入一个可点击的引用。我还没有弄清楚如何单击Intellisense工具提示,但它确实提供了一个类型格式化/彩色显示,帮助您的引用脱颖而出(请注意,该引用必须对Intellisense可用)


旁注:我从来都不知道怎么做一个换行。我能得到的最接近的是双线分隔符,使用标记…

此功能现在在Visual Studio 2019版本16.3.0()中可用

  • 您可以将
    标记用于斜体
  • 您可以将
    标记用于粗体
  • 从发行说明来看,各种html标记似乎都得到了支持,但似乎还没有用这个新特性更新

它看起来是这样的:。

这不是你需要怀疑的注释-任何有效的XML都是可以接受的-这是你需要怀疑的解析结果XML的内容,这将允许一些格式化标记。然后你仍然需要逃避它,因为它应该是有效的XML内容。@Patrickhoffman:我相当肯定
Someboldtext
是有效的XML。没必要逃跑。对不起,你说得对。我正在考虑使用
Joey,你介意让ReSharper尝试一下
strong
?没有变化,因为它明确地告诉我们这只是字面上的字符。与Javadoc不同,XML文档不包含输出为HTML的含义。因此,这种情况并非如此。JavaIDE通常为Javadoc提供呈现HTML的功能,但这是意料之中的事。不需要插件吗?在Visual Studio 2015中已经有可能了吗?对不起@miroxlav,我不是说Visual Studio会理解wiki标记。这只是一种惯例。谢谢,是的,但如果我想添加文本“根据ReadAllFiles和PreserveTimestamp设置返回值”,这些强调方式没有什么用处,它们会降低文本的可读性。因此很少有人为其他程序员编写适当的文档。你所做的是令人钦佩的。