A set of coding guidelines for all C# versions up to 7.3, design principles and layout rules for improving the overall quality of your code development.
I understand that we're referring code reviews. And understand your point. Just saying that it seems like a rare case, when I can't understand type from a variable name and usage (for common examples that I can imagine):
var employees = repository.FindEmployees(criteria); // Don't really care about 'customers' type. Whether it IEnumerable<Person>, IList or List. Just know that it has a collection semantic.
var topSalary = employees.Select(var emp => emp.CalculateYearSalary()).Max(); // While I don't know exact type of 'topSalary' would be, it's not that important to me. I'm pretty sure it's primitive type like Integer or Double.
Depends on the context. In your first example, I might wanna know whether somebody is returning an internal domain entity rather than some kind of DTO construct. If it is the former, you end up with unnecessary class coupling and leaky abstractions. In the second example, the difference between an integer and a double isn't really relevant, but might be considered an serious issue in accounting.
Ehm, wait a minute, wouldn't you detect such inappropriate return type from the method definition? When it should return an int value it surely can't return a complex internal type. You only need to check the method definition once whereas you'd have to analyse and verify its usage many times. And should the return type be something as unspecific as object you'd have another reason to complain, right?
You can't pull out an internal type of a method that just doesn't return it, so you can't hide it in 'var' as well.
Hey Guys, with respect to AV1515. Would the literal used here be considered a magic number when the constructor is define as:
/// <param name="characterCount">The amount of characters that a segment should have.</param>
public Segment(int characterCount) and the usage is as such public class
ModelSegment : Segment { public Model() : base(4) {} }
Would the 4 above be considered magic or is being aware of the definition of the parameter be enough?
@dennisdoomen but lets say the name of the constant is
SegmentCharacterCount, but you are unaware of the base constructor it is used in. Wouldn't it mean that it's not possible review the code for correctness because you wouldn't know whether the name SegmentCharacterCount is correct? On the flip side if you are aware of what the base constructor is doing then wouldn't you be aware of what the literal represents without it being in a constant?
when i run around 20000 task at a time using task.whenall, it won't run more than 1500 task
Can anyone explain what is the issue?
Hi all ,C:\Program Files (x86)\MSBuild\14.0\bin\amd64\Microsoft.Common.CurrentVersion.targets(277,5): error MSB4184: The expression "[System.IO.Path]::GetFullPath(C:/Jenkins/workspace/DataScience/datascience-buildrequest\C:/Jenkins/workspace/DataScience/datascience-buildrequest\Assemblies\)" cannot be evaluated. The given path's format is not supported.
facing below issue in project,please help me on this
But in vs15 machine its building fine
How does AV1200 relate to the old mantra to not use exceptions for control flow?
What I mean is that I don't like to use return values for methods that are not supposed to fail.
If they can fail under normal circumstances, I would make that explicit in the name of the method.
Or by providing a property to see if calling that method is save to be called
E.g.
Save and CanSave
As an example, consider the following service method:
public async Task<IEnumerable<User>> GetUsersAsync(
Guid customerId,
CancellationToken token = default)
{
EnsureArg.IsNotEmpty(customerId, nameof(customerId));
if (!await CompanyExistsAsync(customerId))
{
_logger.LogError(ExceptionMessages.UnknownCustomerException, customerId);
throw new UnknownCustomerException(ExceptionMessages.UnknownCustomerException, customerId);
}
IEnumerable<Data.User> dbUsers = _userRepository.GetUsersForCustomer(customerId);
var users = _mapper.Map<IEnumerable<User>>(dbUsers);
return users;
}
Does AV1200 imply that this is preferred instead of returning result objects with status codes and possibly/optionally an object? E.g. Something like Result<TEntity, TResultCode>.
If there are no users, the enumerable is just empty
No lets assume we are on-boarding a new customer and instead of doing a check if the customer exists we verify if the chosen sub-domain name is still available. Would you use an exception or a result code?