Merge pull request #50949 from wwlpublish/8abf75492a2a474cb9202869f1673d1c21cd1e3d52641905e2d3435dc72bd539-live

PMEds28 · web-flow · commit 2267617ebd1b · 2025-06-16T10:35:47.000+01:00
Modules/M05-create-readable-code-using-conventions-whitespace-comments-c-sharp
diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json
@@ -48633,6 +48633,16 @@
       "source_path": "learn-pr/sqlserver/sql-server-2022-performance-enhancements/8-summary.md",
       "redirect_url": "/training/paths/get-started-querying-with-transact-sql/",
       "redirect_document_id": false
-    }
+    },
+     {
+      "source_path": "learn-pr/wwl-language/csharp-readable-code/5-challenge.md",
+      "redirect_url": "/training/modules/csharp-readable-code/5-exercise-challenge-improve-code-readability",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "learn-pr/wwl-language/csharp-readable-code/6-solution.md",
+      "redirect_url": "/training/modules/csharp-readable-code/6-review-solution-code-readability-challenge",
+      "redirect_document_id": false
+  }
 ]
 }
diff --git a/learn-pr/wwl-language/csharp-readable-code/1-introduction.yml b/learn-pr/wwl-language/csharp-readable-code/1-introduction.yml
@@ -4,7 +4,7 @@ title: Introduction
 metadata:
   title: Introduction
   description: "Introduction"
-  ms.date: 08/16/2024
+  ms.date: 06/16/2025
   author: wwlpublish
   ms.author: cahowd
   ms.topic: unit
diff --git a/learn-pr/wwl-language/csharp-readable-code/2-choose-variable-names.yml b/learn-pr/wwl-language/csharp-readable-code/2-choose-variable-names.yml
@@ -4,7 +4,7 @@ title: Choose variable names that follow rules and conventions
 metadata:
   title: Choose variable names that follow rules and conventions
   description: "Choose variable names that follow rules and conventions"
-  ms.date: 08/16/2024
+  ms.date: 06/16/2025
   author: wwlpublish
   ms.author: cahowd
   ms.topic: unit
diff --git a/learn-pr/wwl-language/csharp-readable-code/3-exercise-comment-code.yml b/learn-pr/wwl-language/csharp-readable-code/3-exercise-comment-code.yml
@@ -4,7 +4,7 @@ title: Exercise - Create effective code comments
 metadata:
   title: Exercise - Create effective code comments
   description: "Exercise - Create effective code comments"
-  ms.date: 08/16/2024
+  ms.date: 06/16/2025
   author: wwlpublish
   ms.author: cahowd
   ms.topic: unit
diff --git a/learn-pr/wwl-language/csharp-readable-code/4-exercise-use-whitespace.yml b/learn-pr/wwl-language/csharp-readable-code/4-exercise-use-whitespace.yml
@@ -4,7 +4,7 @@ title: Exercise - Use whitespace to make your code easier to read
 metadata:
   title: Exercise - Use whitespace to make your code easier to read
   description: "Exercise - Use whitespace to make your code easier to read"
-  ms.date: 08/16/2024
+  ms.date: 06/16/2025
   author: wwlpublish
   ms.author: cahowd
   ms.topic: unit
diff --git a/learn-pr/wwl-language/csharp-readable-code/5-exercise-challenge-improve-code-readability.yml b/learn-pr/wwl-language/csharp-readable-code/5-exercise-challenge-improve-code-readability.yml
@@ -4,12 +4,12 @@ title: Exercise - Complete a challenge activity to improve code readability
 metadata:
   title: Exercise - Complete a challenge activity to improve code readability
   description: "Exercise - Complete a challenge activity to improve code readability"
-  ms.date: 08/16/2024
+  ms.date: 06/16/2025
   author: wwlpublish
   ms.author: cahowd
   ms.topic: unit
   ms.custom:
   - N/A
 durationInMinutes: 7
 content: |
-  [!include[](includes/5-challenge.md)]
+  [!include[](includes/5-exercise-challenge-improve-code-readability.md)]
diff --git a/learn-pr/wwl-language/csharp-readable-code/6-review-solution-code-readability-challenge.yml b/learn-pr/wwl-language/csharp-readable-code/6-review-solution-code-readability-challenge.yml
@@ -4,12 +4,12 @@ title: Review the solution to the improve code readability challenge activity
 metadata:
   title: Review the solution to the improve code readability challenge activity
   description: "Review the solution to the improve code readability challenge activity"
-  ms.date: 08/16/2024
+  ms.date: 06/16/2025
   author: wwlpublish
   ms.author: cahowd
   ms.topic: unit
   ms.custom:
   - N/A
 durationInMinutes: 4
 content: |
-  [!include[](includes/6-solution.md)]
+  [!include[](includes/6-review-solution-code-readability-challenge.md)]
diff --git a/learn-pr/wwl-language/csharp-readable-code/7-knowledge-check.yml b/learn-pr/wwl-language/csharp-readable-code/7-knowledge-check.yml
@@ -4,7 +4,7 @@ title: Module assessment
 metadata:
   title: Module assessment
   description: "Knowledge check"
-  ms.date: 08/16/2024
+  ms.date: 06/16/2025
   author: wwlpublish
   ms.author: cahowd
   ms.topic: unit
diff --git a/learn-pr/wwl-language/csharp-readable-code/8-summary.yml b/learn-pr/wwl-language/csharp-readable-code/8-summary.yml
@@ -4,7 +4,7 @@ title: Summary
 metadata:
   title: Summary
   description: "Summary"
-  ms.date: 08/16/2024
+  ms.date: 06/16/2025
   author: wwlpublish
   ms.author: cahowd
   ms.topic: unit
diff --git a/learn-pr/wwl-language/csharp-readable-code/includes/2-choose-variable-names.md b/learn-pr/wwl-language/csharp-readable-code/includes/2-choose-variable-names.md
@@ -20,7 +20,7 @@ Conventions are suggestions that are agreed upon by the software development com
 - Variable names should be one or more entire words appended together. Don't use contractions because the name of the variable may be unclear to others who are reading your code. For example: `decimal orderAmount;`, NOT `decimal odrAmt;`.
 - Variable names shouldn't include the data type of the variable. You might see some advice to use a style like `string strMyValue;`. It was a popular style years ago. However, most developers don't follow this advice anymore and there are good reasons not to use it.
 
-The example `string firstName;` follows all of these rules and conventions, assuming I want to use this variable to store data that represents someone's first name.
+The example `string firstName;` follows all of these rules and conventions, assuming you want to use this variable to store data that represents someone's first name.
 
 ## Variable name examples
 
diff --git a/learn-pr/wwl-language/csharp-readable-code/includes/3-exercise-comment-code.md b/learn-pr/wwl-language/csharp-readable-code/includes/3-exercise-comment-code.md
@@ -41,22 +41,32 @@ This module includes exercises that guide you through the process of building an
 
     Notice that a command prompt in the Terminal panel displays the folder path for the current folder. For example:  
 
-    ```dos
+    ```PowerShell
     C:\Users\someuser\Desktop>
     ```
 
     > [!NOTE]
     > If you are working on your own PC rather than in a sandbox or hosted environment and you have completed other Microsoft Learn modules in this C# series, you may have already created a project folder for code samples. If that's the case, you can skip over the next step, which is used to create a console app in the TestProject folder.
 
-1. At the Terminal command prompt, to create a new console application in a specified folder, type **dotnet new console -o ./CsharpProjects/TestProject** and then press Enter.
+1. At the Terminal command prompt, to create a new console application in a specified folder, enter the following prompt:
+
+    ```dotnetcli
+    dotnet new console -o ./CsharpProjects/TestProject
+    ```
 
     This .NET CLI command uses a .NET program template to create a new C# console application project in the specified folder location. The command creates the CsharpProjects and TestProject folders for you, and uses TestProject as the name of your `.csproj` file.
 
-1. In the EXPLORER panel, expand the **CsharpProjects** folder.
+    If a message is displayed telling you that the files already exist, continue with the next steps. You'll reuse the existing project files.
+
+1. In the EXPLORER view, expand the **CsharpProjects** folder.
+
+    You should see the **TestProject** folder and two files, a C# program file named Program.cs and a C# project file named TestProject.csproj.
+
+1. On the Visual Studio Code **File** menu, select **Open Folder**.
 
-    You should see the TestProject folder and two files, a C# program file named Program.cs and a C# project file named TestProject.csproj.
+1. In the **Open Folder** dialog, select the **CsharpProjects** folder, and then select **Select Folder**.
 
-1. In the EXPLORER panel, to view your code file in the Editor panel, select **Program.cs**.
+1. In the EXPLORER view, expand the TestProject folder, and then select **Program.cs**.
 
 1. Delete the existing code lines.
 
@@ -66,7 +76,7 @@ This module includes exercises that guide you through the process of building an
 
 ## Create and use code comments
 
-In this task, you will try creating and removing various types of code comments.
+In this task, you will create and remove various types of code comments.
 
 1. In the Visual Studio Code Editor panel, enter the following code:
 
@@ -93,7 +103,7 @@ In this task, you will try creating and removing various types of code comments.
 
 1. On the Visual Studio Code **File** menu, click **Save**.
 
-1. In the EXPLORER panel, to open a Terminal at your TestProject folder location, right-click **TestProject**, and then select **Open in Integrated Terminal**.
+1. In the EXPLORER view, to open a Terminal at your TestProject folder location, right-click **TestProject**, and then select **Open in Integrated Terminal**.
 
 1. At the Terminal command prompt, type **dotnet run** and then press Enter.
 
diff --git a/learn-pr/wwl-language/csharp-readable-code/includes/4-exercise-use-whitespace.md b/learn-pr/wwl-language/csharp-readable-code/includes/4-exercise-use-whitespace.md
@@ -20,7 +20,7 @@ The C# compiler ignores whitespace. To understand how whitespace is ignored, and
 
     1. Use the Open Folder dialog to navigate to, and then open, the **CsharpProjects** folder.
 
-    1. In the Visual Studio Code EXPLORER panel, select **Program.cs**.
+    1. In the Visual Studio Code EXPLORER view, select **Program.cs**.
 
     1. On the Visual Studio Code **Selection** menu, select **Select All**, and then press the Delete key.
 
@@ -42,7 +42,7 @@ The C# compiler ignores whitespace. To understand how whitespace is ignored, and
 
 1. On the Visual Studio Code **File** menu, select **Save**.
 
-1. In the EXPLORER panel, to open a Terminal at your TestProject folder location, right-click **TestProject**, and then select **Open in Integrated Terminal**.
+1. In the EXPLORER view, to open a Terminal at your TestProject folder location, right-click **TestProject**, and then select **Open in Integrated Terminal**.
 
 1. At the Terminal command prompt, type **dotnet run** and then press Enter.
 
diff --git a/learn-pr/wwl-language/csharp-readable-code/includes/5-exercise-challenge-improve-code-readability.md b/learn-pr/wwl-language/csharp-readable-code/includes/5-exercise-challenge-improve-code-readability.md
@@ -1,4 +1,3 @@
-
 Code challenges will reinforce what you've learned and help you gain some confidence before continuing on.
 
 ## Code readability challenge
@@ -15,7 +14,7 @@ In this challenge, you'll use the techniques you learned in this module to impro
 
     1. Use the Open Folder dialog to navigate to, and then open, the **CsharpProjects** folder.
 
-    1. In the Visual Studio Code EXPLORER panel, select **Program.cs**.
+    1. In the Visual Studio Code EXPLORER view, select **Program.cs**.
 
     1. On the Visual Studio Code **Selection** menu, select **Select All**, and then press the Delete key.
 
diff --git a/learn-pr/wwl-language/csharp-readable-code/includes/6-review-solution-code-readability-challenge.md b/learn-pr/wwl-language/csharp-readable-code/includes/6-review-solution-code-readability-challenge.md
@@ -1,4 +1,3 @@
-
 The following code is one possible solution for the challenge from the previous unit.
 
 ```c#
diff --git a/learn-pr/wwl-language/csharp-readable-code/index.yml b/learn-pr/wwl-language/csharp-readable-code/index.yml
@@ -1,12 +1,13 @@
 ### YamlMime:Module
 uid: learn.languages.csharp-readable-code
 metadata:
-  title: Create readable code with conventions, whitespace, and comments in C#
+  title: Create Readable Code with Conventions, Whitespace, and Comments in C#
   description: "Write code that is easier to read, update and support using naming conventions, comments and whitespace."
-  ms.date: 08/16/2024
+  ms.date: 06/16/2025
   author: wwlpublish
   ms.author: cahowd
   ms.topic: module
+  ms.collection: N/A
   ms.custom:
   - N/A
   ms.service: dotnet-csharp
