Lack of Documentation of EntityHelper's EntityEquals Method

[polatefekaya]

abp/framework/src/Volo.Abp.Ddd.Domain/Volo/Abp/Domain/Entities/EntityHelper.cs

Lines 28 to 118 in e6e4602

	public static bool EntityEquals(IEntity? entity1, IEntity? entity2)
	{
	if (entity1 == null || entity2 == null)
	{
	return false;
	}
	//Same instances must be considered as equal
	if (ReferenceEquals(entity1, entity2))
	{
	return true;
	}
	//Must have a IS-A relation of types or must be same type
	var typeOfEntity1 = entity1.GetType();
	var typeOfEntity2 = entity2.GetType();
	if (!typeOfEntity1.IsAssignableFrom(typeOfEntity2) && !typeOfEntity2.IsAssignableFrom(typeOfEntity1))
	{
	return false;
	}
	//Different tenants may have an entity with same Id.
	if (entity1 is IMultiTenant && entity2 is IMultiTenant)
	{
	var tenant1Id = ((IMultiTenant)entity1).TenantId;
	var tenant2Id = ((IMultiTenant)entity2).TenantId;
	if (tenant1Id != tenant2Id)
	{
	if (tenant1Id == null || tenant2Id == null)
	{
	return false;
	}
	if (!tenant1Id.Equals(tenant2Id))
	{
	return false;
	}
	}
	}
	//Transient objects are not considered as equal
	if (HasDefaultKeys(entity1) && HasDefaultKeys(entity2))
	{
	return false;
	}
	var entity1Keys = entity1.GetKeys();
	var entity2Keys = entity2.GetKeys();
	if (entity1Keys.Length != entity2Keys.Length)
	{
	return false;
	}
	for (var i = 0; i < entity1Keys.Length; i++)
	{
	var entity1Key = entity1Keys[i];
	var entity2Key = entity2Keys[i];
	if (entity1Key == null)
	{
	if (entity2Key == null)
	{
	//Both null, so considered as equals
	continue;
	}
	//entity2Key is not null!
	return false;
	}
	if (entity2Key == null)
	{
	//entity1Key was not null!
	return false;
	}
	if (TypeHelper.IsDefaultValue(entity1Key) && TypeHelper.IsDefaultValue(entity2Key))
	{
	return false;
	}
	if (!entity1Key.Equals(entity2Key))
	{
	return false;
	}
	}
	return true;
	}

There are so much details about how entities are compared to satisify "Equality" needs. Maybe a clear documentation of "what is compared how" is can be helpful. In the main documentation in abp.io's page is just super basic overview in that topic.

Maybe a new page for equality comparisons in the main documentation can be helpful.

[polatefekaya]

I can create a pr and add xml comments where I think it can be helpful if you want.