Add Backticks to represent code references in comments

Usage of Backticks to represent code references is only reserved for markdown and other unstructured text. But here using them visually indicates that there's a reference to the code that is written nearby or in a related file somewhere. Though this is not a standard way of representing code in comments, some extensions support multiple quote styles to represent emphasized text.
CommunityToolkit · Jun 3, 2022 · d648a69 · d648a69
1 parent e2a0fb4
commit d648a69
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/CommunityToolkit.Common/CommunityToolkit.Common.csproj b/CommunityToolkit.Common/CommunityToolkit.Common.csproj
@@ -15,8 +15,8 @@
   </PropertyGroup>
 
   <!--
-      Use NETSTANDARD2_1_OR_GREATER define to include .NET Standard 2.1 and .NET 6 shared APIs.
-      They already have [NotNullIfNotNull] and [NotNullWhen] attributes built-in.
+      Use `NETSTANDARD2_1_OR_GREATER` define to include .NET Standard 2.1 and .NET 6 shared APIs.
+      They already have `[NotNullIfNotNull]` and `[NotNullWhen]` attributes built-in.
       Additionally, enable assembly trimming on .NET 6+.
   -->
   <PropertyGroup Condition="'$(TargetFramework)' == 'net6.0'">

diff --git a/CommunityToolkit.Diagnostics/CommunityToolkit.Diagnostics.csproj b/CommunityToolkit.Diagnostics/CommunityToolkit.Diagnostics.csproj
@@ -17,22 +17,22 @@
   <Choose>
     <When Condition="'$(TargetFramework)' == 'netstandard2.0'">
 
-      <!-- .NET Standard 2.0 doesn't have the Span<T> type -->
+      <!-- .NET Standard 2.0 doesn't have the `Span<T>` type -->
       <ItemGroup>
         <PackageReference Include="System.Memory" Version="4.5.4" />
       </ItemGroup>
     </When>
 
     <When Condition="'$(TargetFramework)' == 'netstandard2.1'">
 
-      <!-- .NET Standard 2.1 doesn't have the Unsafe type -->
+      <!-- .NET Standard 2.1 doesn't have the `Unsafe` type -->
       <ItemGroup>
         <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
       </ItemGroup>
     </When>
 
     <!--
-        Use NETSTANDARD2_1_OR_GREATER define to include .NET Standard 2.1 and .NET 6 shared APIs.
+        Use `NETSTANDARD2_1_OR_GREATER` define to include .NET Standard 2.1 and .NET 6 shared APIs.
         Additionally, enable assembly trimming on .NET 6+.
     -->
     <When Condition="'$(TargetFramework)' == 'net6.0'">

diff --git a/CommunityToolkit.HighPerformance/CommunityToolkit.HighPerformance.csproj b/CommunityToolkit.HighPerformance/CommunityToolkit.HighPerformance.csproj
@@ -28,7 +28,7 @@
   <Choose>
     <When Condition="'$(TargetFramework)' == 'netstandard2.0'">
 
-      <!-- .NET Standard 2.0 doesn't have the Span<T>, HashCode and ValueTask types -->
+      <!-- .NET Standard 2.0 doesn't have the `Span<T>`, `HashCode` and `ValueTask` types -->
       <ItemGroup>
         <PackageReference Include="Microsoft.Bcl.HashCode" Version="1.1.1" />
         <PackageReference Include="System.Memory" Version="4.5.4" />
@@ -39,27 +39,27 @@
 
     <When Condition="'$(TargetFramework)' == 'netstandard2.1'">
 
-      <!-- .NET Standard 2.1 doesn't have the Unsafe type -->
+      <!-- .NET Standard 2.1 doesn't have the `Unsafe` type -->
       <ItemGroup>
         <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
       </ItemGroup>
     </When>
 
     <When Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
 
-      <!-- Use NETSTANDARD2_1_OR_GREATER define to include shared APIs -->
+      <!-- Use `NETSTANDARD2_1_OR_GREATER` define to include shared APIs -->
       <PropertyGroup>
         <DefineConstants>NETSTANDARD2_1_OR_GREATER</DefineConstants>
       </PropertyGroup>
 
-      <!-- .NET Core 3.1 has the Unsafe type, but the version it ships with lacks Unsafe.IsNullRef<T> -->
+      <!-- .NET Core 3.1 has the `Unsafe` type, but the version it ships with lacks `Unsafe.IsNullRef<T>` -->
       <ItemGroup>
         <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
       </ItemGroup>
     </When>
 
     <!--
-        Use NETSTANDARD2_1_OR_GREATER define to include .NET Standard 2.1, .NET Core 3.1 and .NET 6 shared APIs.
+        Use `NETSTANDARD2_1_OR_GREATER` define to include .NET Standard 2.1, .NET Core 3.1 and .NET 6 shared APIs.
         Additionally, enable assembly trimming on .NET 6+
     -->
     <When Condition="'$(TargetFramework)' == 'net6.0'">

diff --git a/CommunityToolkit.Mvvm/CommunityToolkit.Mvvm.csproj b/CommunityToolkit.Mvvm/CommunityToolkit.Mvvm.csproj
@@ -37,15 +37,15 @@
     <None Include="CommunityToolkit.Mvvm.targets" Pack="true" PackagePath="build\netstandard2.1" />
   </ItemGroup>
 
-  <!-- .NET Standard 2.0 doesn't have the Span<T> and IAsyncEnumerable<T> types -->
+  <!-- .NET Standard 2.0 doesn't have the `Span<T>` and `IAsyncEnumerable<T>` types -->
   <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
     <PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="6.0.0" />
     <PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
     <PackageReference Include="System.Memory" Version="4.5.4" />
     <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
   </ItemGroup>
 
-  <!-- .NET Standard 2.1 doesn't have the Unsafe type -->
+  <!-- .NET Standard 2.1 doesn't have the `Unsafe` type -->
   <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.1'">
     <PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
     <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />