Add comments and asserts

dotnet · Apr 30, 2024 · e2862e2 · e2862e2
1 parent 67ae809
commit e2862e2
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/src/Compilers/CSharp/Portable/Symbols/MemberSymbolExtensions.cs b/src/Compilers/CSharp/Portable/Symbols/MemberSymbolExtensions.cs
@@ -547,6 +547,7 @@ internal static bool IsExplicitInterfaceImplementation(this Symbol member)
 
         internal static bool IsPartialMember(this Symbol member)
         {
+            Debug.Assert(member.IsDefinition);
             return member
                 is SourceOrdinaryMethodSymbol { IsPartial: true }
                 or SourcePropertySymbol { IsPartial: true }
@@ -555,6 +556,7 @@ internal static bool IsPartialMember(this Symbol member)
 
         internal static bool IsPartialImplementation(this Symbol member)
         {
+            Debug.Assert(member.IsDefinition);
             return member
                 is SourceOrdinaryMethodSymbol { IsPartialImplementation: true }
                 or SourcePropertySymbol { IsPartialImplementation: true }
@@ -563,6 +565,7 @@ internal static bool IsPartialImplementation(this Symbol member)
 
         internal static bool IsPartialDefinition(this Symbol member)
         {
+            Debug.Assert(member.IsDefinition);
             return member
                 is SourceOrdinaryMethodSymbol { IsPartialDefinition: true }
                 or SourcePropertySymbol { IsPartialDefinition: true }

diff --git a/src/Compilers/CSharp/Portable/Symbols/Source/SourceOrdinaryMethodSymbol.cs b/src/Compilers/CSharp/Portable/Symbols/Source/SourceOrdinaryMethodSymbol.cs
@@ -471,6 +471,10 @@ protected sealed override void PartialMethodChecks(BindingDiagnosticBag diagnost
         /// parts of a partial method. Diagnostics are reported on the
         /// implementing part, matching Dev10 behavior.
         /// </summary>
+        /// <remarks>
+        /// This method is analogous to <see cref="SourcePropertySymbol.PartialPropertyChecks" />.
+        /// Whenever new checks are added to this method, the other method should also have those checks added, if applicable.
+        /// </remarks>
         private static void PartialMethodChecks(SourceOrdinaryMethodSymbol definition, SourceOrdinaryMethodSymbol implementation, BindingDiagnosticBag diagnostics)
         {
             Debug.Assert(!ReferenceEquals(definition, implementation));

diff --git a/src/Compilers/CSharp/Portable/Symbols/Source/SourcePropertySymbol.cs b/src/Compilers/CSharp/Portable/Symbols/Source/SourcePropertySymbol.cs
@@ -578,6 +578,10 @@ internal override void AfterAddingTypeMembersChecks(ConversionsBase conversions,
             }
         }
 
+        /// <remarks>
+        /// This method is analogous to <see cref="SourceOrdinaryMethodSymbol.PartialMethodChecks(SourceOrdinaryMethodSymbol, SourceOrdinaryMethodSymbol, BindingDiagnosticBag)" />.
+        /// Whenever new checks are added to this method, the other method should also have those checks added, if applicable.
+        /// </remarks>
         private void PartialPropertyChecks(SourcePropertySymbol implementation, BindingDiagnosticBag diagnostics)
         {
             Debug.Assert(this.IsPartialDefinition);