【问题标题】:What is the purpose of using square brackets in Java code comment?在 Java 代码注释中使用方括号的目的是什么?
【发布时间】:2017-09-30 03:29:46
【问题描述】:

我看到一些谷歌在评论中使用方括号的 Java 代码。
例如:

// [START initialize_auth]
mAuth = FirebaseAuth.getInstance();
// [END initialize_auth]

这种风格有什么特殊用途吗?

【问题讨论】:

  • 也许内部文档或某些特殊编辑器能够解析该块...您需要询问编写它的人

标签: java firebase


【解决方案1】:

这些 sn-ps 是 Firebase documentation 的链接器。

您可以点击 Firebase 网站上的类名,您将被带到示例代码的相应块。

很难说这是否是动态生成的 HTML,但纯 Java 中的那些 cmets 没有这种特殊语法

同样的问题,但对于 iOS:What is this Objective-C/XCode annotation // [START_EXCLUDE]

【讨论】:

  • firebaser here 这些确实是对填充 Firebase 文档中的一些代码 sn-ps 的内部工具的说明。
【解决方案2】:

每个人都有自己的评论风格,但就您的问题而言,这可能是一种组织大型代码库或更快地搜索代码的方法。

【讨论】:

    【解决方案3】:

    可能他们使用方括号来匹配一组字符以供进一步参考。用于自动化编码标准的内部工具。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2012-11-30
      • 2013-05-16
      • 1970-01-01
      • 1970-01-01
      • 2011-10-12
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多