【发布时间】：2016-06-13 06:19:40
【问题描述】：
我对 Android 开发还很陌生。最近我注意到Google自己的示例代码for example中的功能块周围有很多START和END cmets：
// [START configure_signin]
// Configure sign-in to request the user's ID, email address, and basic
// profile. ID and basic profile are included in DEFAULT_SIGN_IN.
GoogleSignInOptions gso =
new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_SIGN_IN)
.requestEmail()
.build();
// [END configure_signin]
我从未在我从事过的其他代码库中看到过这种特殊风格的注释，而且我找不到任何文档或风格指南提及它们在 Android 代码中的用法。
它们是否有任何功能用途（例如，它们是供某些测试或文档框架使用的），还是纯粹为了读者的利益？
【问题讨论】：
-
这可能是为了自动提取代码 sn-ps 用于文档目的。他们的文档文件中可能有一个宏，上面写着“在此处插入来自
SigninActivity.java的configure_signin代码”。我考虑为my book 的代码示例走这条路。我选择不这样做，以避免开发人员在查看完整的源文件时感到困惑。然而，这些 cmets 并不是正常的 Android 应用开发的一部分，不管 Google 为什么将它们放在那里。