[C#] CodeWhisperer Code Comments - Part 2 (#151)

* Codewhisperer comments p2

Author: rachel-mack

source/includes/code-examples/insert-many/InsertMany.cs

@@ -1,3 +1,5 @@
+// Inserts sample documents describing restaurants by using the C# driver
+
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
@@ -13,56 +15,60 @@ public static void Main(string[] args)
     {
         Setup();
 
-        // Attempt to find document before insert
+        // Creates a filter for all documents that have a "name" value of "Mongo's Pizza"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Name, "Mongo's Pizza");
 
+        // Finds all documents that match the filter
         var foundRestaurants = _restaurantsCollection.Find(filter).ToList();
 
         Console.WriteLine($"Number of restaurants found before insert: {foundRestaurants.Count}");
 
-        // Extra space for console readability
+        // Prints extra space for console readability
         Console.WriteLine();
 
         Console.WriteLine("Inserting documents...");
+
+        // Inserts the documents by using a helper method
         InsertManyRestaurants();
 
-        // Find and print newly inserted document
+        // Finds all documents that match the filter after the insert
         foundRestaurants = _restaurantsCollection.Find(filter).ToList();
 
+        // Prints the number of documents found
         Console.WriteLine($"Number of restaurants inserted: {foundRestaurants.Count}");
 
         Cleanup();
     }
 
     private static void InsertManyRestaurants()
     {
-        // Delete sample document if already exists
         Cleanup();
 
         // start-insert-many
-        // Helper method to generate 5 new restaurants
+        // Generates 5 new restaurants by using a helper method
         var restaurants = GenerateDocuments();
 
+        // Inserts the new documents into the restaurants collection
         _restaurantsCollection.InsertMany(restaurants);
         // end-insert-many
     }
 
     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 database
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");
     }
 
     private static List<Restaurant> GenerateDocuments()
     {
-        // Generate 5 new restaurant documents
+        // Generates 5 new restaurant documents
         var restaurantsList = new List<Restaurant>();
         for (int i = 1; i <= 5; i++)
         {

source/includes/code-examples/insert-many/InsertManyAsync.cs

@@ -1,3 +1,5 @@
+// Asynchronously inserts sample documents describing restaurants by using the C# driver
+
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
@@ -13,56 +15,61 @@ public static async Task Main(string[] args)
     {
         Setup();
 
-        // Attempt to find document before insert
+        // Creates a filter for all documents that have a "name" value of "Mongo's Pizza"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Name, "Mongo's Pizza");
 
+        // Finds all documents that match the filter
         var foundRestaurants = _restaurantsCollection.Find(filter).ToList();
 
+        // Prints the number of documents found
         Console.WriteLine($"Number of restaurants found before insert: {foundRestaurants.Count}");
 
-        // Extra space for console readability
+        // Prints extra space for console readability
         Console.WriteLine();
 
         Console.WriteLine("Inserting documents...");
+
+        // Asynchronously inserts the documents by using a helper method
         await InsertManyRestaurantsAsync();
 
-        // Find and print newly inserted document
+        // Finds all documents that match the filter after the insert
         foundRestaurants = _restaurantsCollection.Find(filter).ToList();
 
+        // Prints the number of documents found
         Console.WriteLine($"Number of restaurants inserted: {foundRestaurants.Count}");
 
         Cleanup();
     }
 
     private static async Task InsertManyRestaurantsAsync()
     {
-        // Delete sample document if already exists
         Cleanup();
 
         // start-insert-many
-        // Helper method to generate 5 new restaurants
+        // Generates 5 new restaurants by using a helper method
         var restaurants = GenerateDocuments();
 
+        // Asynchronously inserts the new documents into the restaurants collection
         await _restaurantsCollection.InsertManyAsync(restaurants);
         // end-insert-many
     }
 
     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 database
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");
     }
 
     private static List<Restaurant> GenerateDocuments()
     {
-        // Generate 5 new restaurant documents
+        // Generates 5 new restaurant documents
         var restaurantsList = new List<Restaurant>();
         for (int i = 1; i <= 5; i++)
         {

source/includes/code-examples/insert-one/InsertOne.cs

@@ -1,3 +1,5 @@
+// Inserts a sample document describing a restaurant by using the C# driver
+
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
@@ -16,23 +18,25 @@ public static void Main(string[] args)
         Console.WriteLine("Inserting a document...");
         InsertOneRestaurant();
 
+        // Creates a filter for all documents that have a "name" value of "Mongo's Pizza"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Name, "Mongo's Pizza");
 
-        // find and print newly inserted document
+        // Finds the newly inserted document by using the filter
         var document = _restaurantsCollection.Find(filter).FirstOrDefault();
 
+        // Prints the document
         Console.WriteLine($"Document Inserted: {document.ToBsonDocument()}");
 
         Cleanup();
     }
 
     private static void InsertOneRestaurant()
     {
-        // delete sample document if already exists
         Cleanup();
 
         // start-insert-one
+        // Generates a new restaurant document
         Restaurant newRestaurant = new()
         {
             Name = "Mongo's Pizza",
@@ -46,17 +50,18 @@ private static void InsertOneRestaurant()
             Borough = "Manhattan",
         };
 
+        // Inserts the new document into the restaurants collection
         _restaurantsCollection.InsertOne(newRestaurant);
         // end-insert-one
     }
 
     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 database
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/insert-one/InsertOneAsync.cs

@@ -1,3 +1,5 @@
+// Asynchronously inserts a sample document describing a restaurant by using the C# driver
+
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
@@ -16,23 +18,25 @@ public static async Task Main(string[] args)
         Console.WriteLine("Inserting a document...");
         await InsertOneRestaurantAsync();
 
-        // find and print newly inserted document
+        // Creates a filter for all documents that have a "name" value of "Mongo's Pizza"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Name, "Mongo's Pizza");
 
+        // Finds the newly inserted document by using the filter
         var document = _restaurantsCollection.Find(filter).FirstOrDefault();
 
+        // Prints the document
         Console.WriteLine($"Document Inserted: {document.ToBsonDocument()}");
 
         Cleanup();
     }
 
     private static async Task InsertOneRestaurantAsync()
     {
-        // delete sample document if already exists
         Cleanup();
 
         // start-insert-one-async
+        // Generates a new restaurant document
         Restaurant newRestaurant = new()
         {
             Name = "Mongo's Pizza",
@@ -46,17 +50,18 @@ private static async Task InsertOneRestaurantAsync()
             Borough = "Manhattan",
         };
 
+        // Asynchronously inserts the new document into the restaurants collection
         await _restaurantsCollection.InsertOneAsync(newRestaurant);
         // end-insert-one-async
     }
 
     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 database
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");