¿Cómo funciona Query.prototype.comment() en Mongoose?

El Query.prototype.comment() se usa para especificar las opciones de comentarios. Hace posible adjuntar un comentario a una consulta en cualquier contexto en el que pueda aparecer $query.
Sintaxis:

Query.prototype.comment()

Parámetros: esta función tiene un parámetro de array, es decir, un comentario de tipo string.
Valor de retorno: esta función devuelve el objeto de consulta.
Instalación de mangosta:

npm install mongoose

Después de instalar el módulo mongoose, puede verificar su versión mongoose en el símbolo del sistema usando el comando. 

npm mongoose --version

Ahora, cree una carpeta y agregue un archivo, por ejemplo, index.js como se muestra a continuación.

Ejemplo 1:

const mongoose = require('mongoose');
  
// Database connection
mongoose.connect('mongodb://127.0.0.1:27017/geeksforgeeks', {
    useNewUrlParser: true,
    useCreateIndex: true,
    useUnifiedTopology: true
});
  
// User model
const User = mongoose.model('User', { 
    name: { type: String },
    age: { type: Number }
});
  
var query = User.find();
query.comment('Query to find all documents')
  
console.log("Comment: ", query.options)

Pasos para ejecutar el programa: 
 

La estructura del proyecto se verá así: 
 

Ejecute el archivo index.js usando el siguiente comando: 

node index.js

Producción: 

Comment:  { comment: 'Query to find all documents' }

Ejemplo 2:

const express = require('express');
const mongoose = require('mongoose');
const app = express()
  
// Database connection
mongoose.connect('mongodb://127.0.0.1:27017/geeksforgeeks', {
    useNewUrlParser: true,
    useCreateIndex: true,
    useUnifiedTopology: true
});
  
// User model
const User = mongoose.model('User', { 
    name: { type: String },
    age: { type: Number }
});
  
var query = User.find();
query.comment('Find All')
  
console.log("Comment: ", query.options);
  
app.listen(3000, function(error ) {
    if(error) console.log(error)
    console.log("Server listening on PORT 3000")
});

Pasos para ejecutar el programa:

La estructura del proyecto se verá así:

Ejecute el archivo index.js usando el siguiente comando: 

node index.js

Producción: 

Server listening on PORT 3000
Comment:  { comment: 'Find All' }

Referencia: https://mongoosejs.com/docs/api/query.html#query_Query-comment