Skip to content

Commit d648a69

Browse files
committed
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.
1 parent e2a0fb4 commit d648a69

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

CommunityToolkit.Common/CommunityToolkit.Common.csproj

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
</PropertyGroup>
1616

1717
<!--
18-
Use NETSTANDARD2_1_OR_GREATER define to include .NET Standard 2.1 and .NET 6 shared APIs.
19-
They already have [NotNullIfNotNull] and [NotNullWhen] attributes built-in.
18+
Use `NETSTANDARD2_1_OR_GREATER` define to include .NET Standard 2.1 and .NET 6 shared APIs.
19+
They already have `[NotNullIfNotNull]` and `[NotNullWhen]` attributes built-in.
2020
Additionally, enable assembly trimming on .NET 6+.
2121
-->
2222
<PropertyGroup Condition="'$(TargetFramework)' == 'net6.0'">

CommunityToolkit.Diagnostics/CommunityToolkit.Diagnostics.csproj

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,22 @@
1717
<Choose>
1818
<When Condition="'$(TargetFramework)' == 'netstandard2.0'">
1919

20-
<!-- .NET Standard 2.0 doesn't have the Span<T> type -->
20+
<!-- .NET Standard 2.0 doesn't have the `Span<T>` type -->
2121
<ItemGroup>
2222
<PackageReference Include="System.Memory" Version="4.5.4" />
2323
</ItemGroup>
2424
</When>
2525

2626
<When Condition="'$(TargetFramework)' == 'netstandard2.1'">
2727

28-
<!-- .NET Standard 2.1 doesn't have the Unsafe type -->
28+
<!-- .NET Standard 2.1 doesn't have the `Unsafe` type -->
2929
<ItemGroup>
3030
<PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
3131
</ItemGroup>
3232
</When>
3333

3434
<!--
35-
Use NETSTANDARD2_1_OR_GREATER define to include .NET Standard 2.1 and .NET 6 shared APIs.
35+
Use `NETSTANDARD2_1_OR_GREATER` define to include .NET Standard 2.1 and .NET 6 shared APIs.
3636
Additionally, enable assembly trimming on .NET 6+.
3737
-->
3838
<When Condition="'$(TargetFramework)' == 'net6.0'">

CommunityToolkit.HighPerformance/CommunityToolkit.HighPerformance.csproj

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<Choose>
2929
<When Condition="'$(TargetFramework)' == 'netstandard2.0'">
3030

31-
<!-- .NET Standard 2.0 doesn't have the Span<T>, HashCode and ValueTask types -->
31+
<!-- .NET Standard 2.0 doesn't have the `Span<T>`, `HashCode` and `ValueTask` types -->
3232
<ItemGroup>
3333
<PackageReference Include="Microsoft.Bcl.HashCode" Version="1.1.1" />
3434
<PackageReference Include="System.Memory" Version="4.5.4" />
@@ -39,27 +39,27 @@
3939

4040
<When Condition="'$(TargetFramework)' == 'netstandard2.1'">
4141

42-
<!-- .NET Standard 2.1 doesn't have the Unsafe type -->
42+
<!-- .NET Standard 2.1 doesn't have the `Unsafe` type -->
4343
<ItemGroup>
4444
<PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
4545
</ItemGroup>
4646
</When>
4747

4848
<When Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
4949

50-
<!-- Use NETSTANDARD2_1_OR_GREATER define to include shared APIs -->
50+
<!-- Use `NETSTANDARD2_1_OR_GREATER` define to include shared APIs -->
5151
<PropertyGroup>
5252
<DefineConstants>NETSTANDARD2_1_OR_GREATER</DefineConstants>
5353
</PropertyGroup>
5454

55-
<!-- .NET Core 3.1 has the Unsafe type, but the version it ships with lacks Unsafe.IsNullRef<T> -->
55+
<!-- .NET Core 3.1 has the `Unsafe` type, but the version it ships with lacks `Unsafe.IsNullRef<T>` -->
5656
<ItemGroup>
5757
<PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
5858
</ItemGroup>
5959
</When>
6060

6161
<!--
62-
Use NETSTANDARD2_1_OR_GREATER define to include .NET Standard 2.1, .NET Core 3.1 and .NET 6 shared APIs.
62+
Use `NETSTANDARD2_1_OR_GREATER` define to include .NET Standard 2.1, .NET Core 3.1 and .NET 6 shared APIs.
6363
Additionally, enable assembly trimming on .NET 6+
6464
-->
6565
<When Condition="'$(TargetFramework)' == 'net6.0'">

CommunityToolkit.Mvvm/CommunityToolkit.Mvvm.csproj

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@
3737
<None Include="CommunityToolkit.Mvvm.targets" Pack="true" PackagePath="build\netstandard2.1" />
3838
</ItemGroup>
3939

40-
<!-- .NET Standard 2.0 doesn't have the Span<T> and IAsyncEnumerable<T> types -->
40+
<!-- .NET Standard 2.0 doesn't have the `Span<T>` and `IAsyncEnumerable<T>` types -->
4141
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
4242
<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="6.0.0" />
4343
<PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
4444
<PackageReference Include="System.Memory" Version="4.5.4" />
4545
<PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />
4646
</ItemGroup>
4747

48-
<!-- .NET Standard 2.1 doesn't have the Unsafe type -->
48+
<!-- .NET Standard 2.1 doesn't have the `Unsafe` type -->
4949
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.1'">
5050
<PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
5151
<PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="6.0.0" />

0 commit comments

Comments
 (0)