三个前斜线用于盖帽评论

Three forward slashes for block commenting?

本文关键字：用于 评论 三个      更新时间：2023-10-16

第一次注意到这一点是在Notepad++中，其中//注释和///注释以不同的颜色显示。

Doxygen透露了更多关于它的信息，但我不相信它的疗效。

  1. 既然键入/*和*/要容易得多，为什么有人会使用三截评论风格？（我认为必须有一个更好的解释，而不是在嵌套注释时有用）
  2. 为了使其可用，编辑器是否支持三斜杠的块注释，就像Visual Studio支持多行注释的Ctrl+k Ctrl+c一样

在Visual Studio中，///表示文档，而不仅仅是注释。按照你的链接，解释是一样的。它用于修饰注释，这些注释将通过编辑器或其他工具专门格式化为类、方法、命名空间等的文档。

作者可能打算将文档放在///之后

在我工作的地方，由于缺乏编码风格指南，我们使用了3种风格的doxygen注释块进行文档编写。

  1. ///
  2. //
  3. /***/
  1. 当然，打三次同一个键比打两个不同的键更容易
  2. 不知道其他IDE，但XCode4支持代码片段，您可以在其中键入几乎任何内容。在Visual Studio上，我使用Visual Assist X，它给了我同样的东西。XCode4示例，Visual AssistX示例。我不得不假设其他IDE也提供类似的功能

也就是说，是的，我也遇到过三斜杠，它们通常用于表示像doxygen这样的自动文档系统会选择的注释。

在C#中///将实际覆盖变量悬停文本，例如

///<summary>
/// This method is for executing some test code.
///<summary>
public void SomeMethod() {}

在另一个类文件或类的更深层次，您可以将鼠标悬停在方法、类或静态变量上，它将提供一个工具提示，说明的摘要

相关文章：