定义
cursor.comment()重要
mongosh 方法
本页面提供
mongosh方法的相关信息。这不是 特定于语言的驱动程序（例如 Node.js）的文档。如需了解 MongoDB API 驱动程序，请参阅特定语言的 MongoDB 驱动程序文档。
在查询中添加
comment字段。cursor.comment()通过以下语法实现：cursor.comment( <string> )comment()有以下参数：Parameter类型说明comment字符串
要应用于查询的注释。
兼容性
此方法可用于以下环境中托管的部署：
- MongoDB Atlas：用于云中 MongoDB 部署的完全托管服务
注意
所有 MongoDB Atlas 集群都支持此命令。有关 Atlas 对所有命令的支持的信息，请参阅不支持的命令。
MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本
MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本
行为
comment() 将注释字符串与查找操作相关联。 这样可以更轻松地在以下诊断输出中跟踪特定查询：
请参阅配置mongod日志的日志详细程度、数据库分析器教程或db.currentOp()命令。
例子
以下操作将注释附加到查询在restaurants collection：
db.restaurants.find( { "borough" : "Manhattan" }).comment( "Find all Manhattan restaurants" )输出示例
system.profile
{ "op" : "query", "ns" : "guidebook.restaurant", "query" : { "find" : "restaurant", "filter" : { "borough" : "Manhattan" }, "comment" : "Find all Manhattan restaurants" }, ...}mongod log
以下是mongod日志的摘录。 为便于阅读，已对其进行格式化。
2015-11-23T13:09:16.202-05:00 I COMMAND [conn1] command guidebook.restaurant command: find { find: "restaurant", filter: { "borough" : "Manhattan" }, comment: "Find all Manhattan restaurants" } ...db.currentOp()
假设以下操作当前正在mongod实例上运行：
db.restaurants.find( { "borough" : "Manhattan" }).comment("Find all Manhattan restaurants")运行db.currentOp()命令会返回以下内容：
{ "inprog" : [ { "host" : "198.51.100.1:27017", "desc" : "conn3", "connectionId" : 3, ...
"op" : "query", "ns" : "test.$cmd", "command" : { "find" : "restaurants", "filter" : { "borough" : "Manhattan" }, "comment" : "Find all Manhattan restaurants", "$db" : "test" }, "numYields" : 0, ... } ], "ok" : 1}