Inconsistent naming of async methods #1009

CniKKoR · 2024-01-29T14:15:22Z

I know it's not an issue in general, but there is no consistent sceme of naming async methods, at least none I noticed.

Also all async methods should include the Async Suffix.

Source:
https://learn.microsoft.com/en-us/dotnet/csharp/asynchronous-programming/task-asynchronous-programming-model#BKMK_HowtoWriteanAsyncMethod

The name of an async method, by convention, ends with an "Async" suffix.

for exmaple:

https://github.com/dotnet-architecture/eShopOnWeb/blob/main/src/Web/Pages/Shared/Components/BasketComponent/Basket.cs

public async Task<IViewComponentResult> InvokeAsync() {    ...    }

private async Task<int> CountTotalBasketItems() {    ...    }

private string? GetAnnonymousIdFromCookie() {    ...    }

For consistency CountTotalBasketItems() should also have the Suffix like InvokeAsync()

another example:

https://github.com/dotnet-architecture/eShopOnWeb/blob/main/src/Web/Pages/Admin/EditCatalogItem.cshtml.cs

public void OnGet(CatalogItemViewModel catalogModel) {    ...    }

public async Task<IActionResult> OnPostAsync() {    ...    }

All fine up here, BUT:

https://github.com/dotnet-architecture/eShopOnWeb/blob/main/src/Web/Pages/Basket/Index.cshtml.cs

public async Task OnGet() {    ...    }

public async Task<IActionResult> OnPost(CatalogItemViewModel productDetails) {    ...    }

public async Task OnPostUpdate(IEnumerable<BasketItemViewModel> items)  {    ...    }

The text was updated successfully, but these errors were encountered:

ardalis · 2024-01-29T15:16:39Z

Probably we should update the editorconfig as this PR does:
ardalis/EditorConfig#2

Kamyab7 linked a pull request Feb 11, 2024 that will close this issue

Fixed inconsistent naming of async methods #1014

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Inconsistent naming of async methods #1009

Inconsistent naming of async methods #1009

CniKKoR commented Jan 29, 2024 •

edited

ardalis commented Jan 29, 2024

Inconsistent naming of async methods #1009

Inconsistent naming of async methods #1009

Comments

CniKKoR commented Jan 29, 2024 • edited

for exmaple:

another example:

ardalis commented Jan 29, 2024

CniKKoR commented Jan 29, 2024 •

edited