[C#] CodeWhisperer Code Comments - Part 1 (#149)

* CodeWhisperer Code Comments for DeleteMany, DeleteOne, FindMany and FindOne, both sync and async

Author: rachel-mack

source/includes/code-examples/delete-many/DeleteMany.cs

@@ -1,3 +1,5 @@
+// Deletes multiple documents from a collection by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 
@@ -17,7 +19,7 @@ public static void Main(string[] args)
 
         var docs = _restaurantsCollection.Find(filter).ToList();
 
-        // Deleting documents using builders
+        // Deletes documents by using builders
         Console.WriteLine("Deleting documents...");
         var result = DeleteMultipleRestaurantsBuilder();
 
@@ -26,12 +28,16 @@ public static void Main(string[] args)
         Restore(docs);
     }
 
+    // Deletes all documents that have a Borough value of "Brooklyn"
     private static DeleteResult DeleteMultipleRestaurantsBuilder()
     {
-        // start-delete-many-builders
+        // start-delete-many-builders 
+        // Creates a filter for all documents that have a
+        // "borough" value of "Brooklyn"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Borough, "Brooklyn");
 
+        // Deletes all documents that match the filter
         return _restaurantsCollection.DeleteMany(filter);
         // end-delete-many-builders
     }
@@ -44,11 +50,11 @@ private static void Restore(IEnumerable<Restaurant> docs)
 
     private static void Setup()
     {
-        // This allows automapping of the camelCase database fields to our models. 
+        // Allows automapping of the camelCase database fields to models 
         var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
         ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
 
-        // Establish the connection to MongoDB and get the restaurants database
+        // Establishes the connection to MongoDB and accesses the "restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/delete-many/DeleteManyAsync.cs

@@ -1,3 +1,5 @@
+// Asynchronously deletes multiple documents from a collection by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 
@@ -17,7 +19,7 @@ public static async Task Main(string[] args)
 
         var docs = _restaurantsCollection.Find(filter).ToList();
 
-        // Deleting documents using builders
+        // Deletes documents by using builders
         Console.WriteLine("Deleting documents...");
         var result = await DeleteMultipleRestaurantsBuilderAsync();
 
@@ -28,12 +30,16 @@ public static async Task Main(string[] args)
         return result;
     }
 
+    // Deletes all documents that have a Borough value of "Brooklyn"
     private static async Task<DeleteResult> DeleteMultipleRestaurantsBuilderAsync()
     {
         // start-delete-many-async
+        // Creates a filter for all documents that have a
+        // "borough" value of "Brooklyn"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Borough, "Brooklyn");
 
+        // Asynchronously deletes all documents that match the filter
         return await _restaurantsCollection.DeleteManyAsync(filter);
         // end-delete-many-async
     }
@@ -46,11 +52,11 @@ private static void Restore(IEnumerable<Restaurant> docs)
 
     private static void Setup()
     {
-        // This allows automapping of the camelCase database fields to our models. 
+        // Allows automapping of the camelCase database fields to models 
         var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
         ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
 
-        // Establish the connection to MongoDB and get the restaurants database
+        // Establishes the connection to MongoDB and accesses the "restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/delete-one/DeleteOne.cs

@@ -1,3 +1,5 @@
+// Deletes a document from a collection by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 
@@ -17,7 +19,7 @@ public static void Main(string[] args)
 
         var doc = _restaurantsCollection.Find(filter).First();
 
-        // Delete a document using builders
+        // Deletes a document by using builders
         Console.WriteLine("Deleting a document with builders...");
         var result = DeleteARestaurantBuilder();
 
@@ -29,9 +31,11 @@ public static void Main(string[] args)
     private static DeleteResult DeleteARestaurantBuilder()
     {
         // start-delete-one-builders
+        // Creates a filter for all documents that have a "name" value of "Ready Penny Inn"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Name, "Ready Penny Inn");
 
+        // Deletes the first document that matches the filter
         return _restaurantsCollection.DeleteOne(filter);
         // end-delete-one-builders
     }
@@ -43,11 +47,11 @@ private static void Restore(Restaurant doc)
 
     private static void Setup()
     {
-        // This allows automapping of the camelCase database fields to our models. 
+        // Allows automapping of the camelCase database fields to models 
         var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
         ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
 
-        // Establish the connection to MongoDB and get the restaurants database
+        // Establishes the connection to MongoDB and accesses the "restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/delete-one/DeleteOneAsync.cs

@@ -1,3 +1,5 @@
+// Asynchronously deletes a document from a collection by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 
@@ -17,7 +19,7 @@ public static async Task Main(string[] args)
 
         var doc = _restaurantsCollection.Find(filter).First();
 
-        // Delete a document using builders
+        // Deletes a document by using builders
         Console.WriteLine("Deleting a document with builders...");
         var result = await DeleteARestaurantBuilderAsync();
 
@@ -29,9 +31,11 @@ public static async Task Main(string[] args)
     private static async Task<DeleteResult> DeleteARestaurantBuilderAsync()
     {
         // start-delete-one-builders-async
+        // Creates a filter for all documents that have a "name" value of "Ready Penny Inn"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Name, "Ready Penny Inn");
 
+        // Asynchronously deletes the first document that matches the filter
         return await _restaurantsCollection.DeleteOneAsync(filter);
         // end-delete-one-builders-async
     }
@@ -43,11 +47,11 @@ private static void Restore(Restaurant doc)
 
     private static void Setup()
     {
-        // This allows automapping of the camelCase database fields to our models. 
+        // Allows automapping of the camelCase database fields to models 
         var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
         ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
 
-        // Establish the connection to MongoDB and get the restaurants database
+        // Establishes the connection to MongoDB and accesses the "restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/find-many/FindMany.cs

@@ -1,3 +1,5 @@
+// Retrieves documents that match a query filter by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 
@@ -12,22 +14,22 @@ public static void Main(string[] args)
     {
         Setup();
 
-        // Find multiple documents using builders
+        // Finds multiple documents by using builders
         Console.WriteLine("Finding documents with builders...:");
         var restaurants = FindMultipleRestaurantsBuilderSync();
         Console.WriteLine($"Number of documents found: {restaurants.Count}");
 
-        // Extra space for console readability 
+        // Prints extra space for console readability 
         Console.WriteLine();
 
-        // Find multiple documents using LINQ
+        // Retrieves multiple documents by using LINQ
         Console.WriteLine("Finding documents with LINQ...:");
         restaurants = FindMultipleRestaurantsLinqSync();
         Console.WriteLine($"Number of documents found: {restaurants.Count}");
 
         Console.WriteLine();
 
-        // Find all restaurants
+        // Retrieves all documents in the "restaurants" collection
         Console.WriteLine("Finding all documents...:");
         restaurants = FindAllRestaurantsSync();
         Console.WriteLine($"Number of documents found: {restaurants.Count}");
@@ -36,15 +38,18 @@ public static void Main(string[] args)
     public static List<Restaurant> FindMultipleRestaurantsBuilderSync()
     {
         // start-find-builders-sync
+        // Creates a filter for all documents that have a "cuisine" value of "Pizza"
         var filter = Builders<Restaurant>.Filter
             .Eq("cuisine", "Pizza");
 
+        // Retrieves all documents that match the filter
         return _restaurantsCollection.Find(filter).ToList();
         // end-find-builders-sync
     }
 
     public static List<Restaurant> FindMultipleRestaurantsLinqSync()
     {
+        // Retrieves all documents with a "cuisine" value of "Pizza" by using a LINQ query
         // start-find-linq-sync
         return _restaurantsCollection.AsQueryable()
             .Where(r => r.Cuisine == "Pizza").ToList();
@@ -63,11 +68,11 @@ private static List<Restaurant> FindAllRestaurantsSync()
 
     private static void Setup()
     {
-        // This allows automapping of the camelCase database fields to our models. 
+        // Allows automapping of the camelCase database fields to models 
         var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
         ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
 
-        // Establish the connection to MongoDB and get the restaurants database
+        // Establishes the connection to MongoDB and accesses the "restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/find-many/FindManyAsync.cs

@@ -1,3 +1,5 @@
+// Asynchronously retrieves documents that match a query filter by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 using MongoDB.Driver.Linq;
@@ -13,22 +15,22 @@ public static async Task Main(string[] args)
     {
         Setup();
 
-        // Find multiple documents using builders
+        // Finds multiple documents by using builders
         Console.WriteLine("Finding documents with builders...:");
         var restaurantsBuilders = await FindMultipleRestaurantsBuilderAsync();
         Console.WriteLine($"Number of documents found: {restaurantsBuilders.Count}");
 
-        // Extra space for console readability 
+        // Prints extra space for console readability 
         Console.WriteLine();
 
-        // Find multiple documents using LINQ
+        // Retrieves multiple documents by using LINQ
         Console.WriteLine("Finding documents with LINQ...:");
         var restaurantsLinq = await FindMultipleRestaurantsLinqAsync();
         Console.WriteLine($"Number of documents found: {restaurantsLinq.Count}");
 
         Console.WriteLine();
 
-        // Find all documents
+        // Retrieves all documents in the "restaurants" collection
         Console.WriteLine("Finding all documents...:");
         var allRestaurants = await FindAllRestaurantsAsync();
         Console.WriteLine($"Number of documents found: {allRestaurants.Count}");
@@ -37,15 +39,18 @@ public static async Task Main(string[] args)
     private static async Task<List<Restaurant>> FindMultipleRestaurantsBuilderAsync()
     {
         // start-find-builders-async
+        // Creates a filter for all documents that have a "cuisine" value of "Pizza"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Cuisine, "Pizza");
 
+        // Asynchronously retrieves all documents that match the filter
         return await _restaurantsCollection.Find(filter).ToListAsync();
         // end-find-builders-async
     }
 
     private static async Task<List<Restaurant>> FindMultipleRestaurantsLinqAsync()
     {
+        // Asynchronously retrieves all documents with a "cuisine" value of "Pizza" by using a LINQ query
         // start-find-linq-async
         return await _restaurantsCollection.AsQueryable()
             .Where(r => r.Cuisine == "Pizza").ToListAsync();
@@ -64,11 +69,11 @@ private static async Task<List<Restaurant>> FindAllRestaurantsAsync()
 
     private static void Setup()
     {
-        // This allows automapping of the camelCase database fields to our models. 
+        // Allows automapping of the camelCase database fields to models 
         var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
         ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
 
-        // Establish the connection to MongoDB and get the restaurants database
+        // Establishes the connection to MongoDB and accesses the "restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/find-one/FindOne.cs

@@ -1,3 +1,5 @@
+// Retrieves a document that match a query filter by using the C# driver
+
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
@@ -13,24 +15,26 @@ public static void Main(string[] args)
     {
         Setup();
 
-        // Find one document using builders
+        // Finds one document by using builders
         Console.WriteLine("Finding a document with builders...");
         FindOneRestaurantBuilder();
 
-        // Extra space for console readability 
+        // Prints extra space for console readability 
         Console.WriteLine();
 
-        // Find one document using LINQ
+        // Finds one document by using LINQ
         Console.WriteLine("Finding a document with LINQ...");
         FindOneRestaurantLinq();
     }
 
     private static void FindOneRestaurantBuilder()
     {
         // start-find-builders
+        // Creates a filter for all documents that have a "name" value of "Bagels N Buns"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Name, "Bagels N Buns");
 
+        // Retrieves the first document that matches the filter
         var restaurant = _restaurantsCollection.Find(filter).FirstOrDefault();
         // end-find-builders
 
@@ -49,11 +53,11 @@ private static void FindOneRestaurantLinq()
 
     private static void Setup()
     {
-        // This allows automapping of the camelCase database fields to our models. 
+        // Allows automapping of the camelCase database fields to models 
         var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
         ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
 
-        // Establish the connection to MongoDB and get the restaurants database
+        // Establishes the connection to MongoDB and accesses the "restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");