【问题标题】:Three forward slashes for block commenting?三个正斜杠用于块评论?
【发布时间】:2021-10-12 01:09:22
【问题描述】:

首先在 Notepad++ 中注意到这一点,其中 // cmets 和 /// cmets 以不同的颜色显示。

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

  1. 当键入/**/ 更容易时,为什么有人会使用三斜杠注释样式? (我认为必须有一个比嵌套 cmets 有用的更好的解释
  2. 为了使其可用,编辑器是否支持三斜杠的块注释,就像 Visual Studio 支持多行 cmets 的 Ctrl+k Ctrl+c 一样?

【问题讨论】:

  • 你在使用 Doxygen 吗?这也是 Doxygen 推荐使用 /// 而不是 /* */ 的 C++ 代码文档的更多原因。
  • 文档是/** */
  • 好的,这是用于文档的。我认为这是做多线 cmets 的另一种/更好的方式。

标签: c++


【解决方案1】:

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

在我工作的地方,由于缺乏编码风格指南,我们使用 3 种风格的 doxygen 注释块来记录文档。

  1. ///
  2. //!
  3. /** */

【讨论】:

    【解决方案2】:
    1. 当然,按三次同一个键比按两个单独的键更容易。
    2. 不知道其他 IDE,但 XCode4 支持代码 sn-ps,您可以在其中键入几乎任何内容。在 Visual Studio 上,我使用 Visual Assist X,它给了我同样的东西。 XCode4 Example,Visual AssistX example。我不得不假设其他 IDE 提供了类似的功能。

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

    【讨论】:

    • Visual Assist X 也有 extend-multiline-cmets 选项,它与 sn-ps 一起使用使得 /** * */ cmets 几乎不需要任何工作。
    【解决方案3】:

    在 Visual Studio 中,/// 表示 documentation 而不仅仅是 cmets。按照您的链接,解释是相同的。它用于装饰将通过您的编辑器或其他工具专门格式化为类、方法、命名空间等的文档的 cmets。

    【讨论】:

    • 这不是 Visual Studio 而是更多特定于 C#。 Visual Studio 中的 C++ 显然可以有/// cmets,但它们没有特殊含义,doc-comment-viewer 也会显示///* */ cmets。
    • 我还是不明白。我想发表评论,例如一个功能,当我的鼠标悬停在它上面时,我的评论将可见或在菜单中,当你可以选择类函数时。该怎么做?
    • 是否存在任何记录的快捷方式?一直创建 3 个/ 很无聊。 Ctrl + K 创建 2 /,而不是 3..
    • @Arkady 我真的不明白在这种情况下“无聊”是什么意思。如果您在输入新行时使用 3 '///' 创建单行,则新行也将以 3 '///' 斜杠开头。
    • @linuxuser27 哇,我的设置没有发生这种情况,即我需要在每一行上手动输入“///”。如何设置?
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2015-08-11
    • 1970-01-01
    • 2012-05-17
    • 1970-01-01
    相关资源
    最近更新 更多