Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Options pattern class naming convention #34384

Closed
backlash1897 opened this issue Dec 17, 2024 · 1 comment
Closed

Options pattern class naming convention #34384

backlash1897 opened this issue Dec 17, 2024 · 1 comment
Assignees
@tdykstra
Labels
aspnet-core/svc fundamentals/subsvc product-question seQUESTered Identifies that an issue has been imported into Quest. Source - Docs.ms Docs Customer feedback via GitHub Issue

Comments

@backlash1897
Copy link

backlash1897 commented Dec 17, 2024 •
edited by sequestor bot
Loading

Description

Hello documentation team,

Is it best practice to name the class with the "Options" suffix?

e.g. PositionOptions, NameTitleOptions

In another example in the article the "Settings" suffix is used:

TopItemSettings

Page URL

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/configuration/options?view=aspnetcore-9.0&preserve-view=true

Content source URL

https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/fundamentals/configuration/options.md

Document ID

dc7e3449-650b-d117-5eac-69e5ccb250cb

Article author

@tdykstra

Related Issues

Associated WorkItem - 356542
@tdykstra tdykstra self-assigned this Dec 17, 2024
@tdykstra tdykstra added product-question reQUEST Triggers an issue to be imported into Quest and removed ⌚ Not Triaged labels Dec 17, 2024
@tdykstra
Copy link
Contributor

It's outside the scope of this documentation to recommend a naming practice. "Options" makes sense, but so does "Settings." What to name these classes is a decision best left up to each developer team.

@dotnetrepoman dotnetrepoman bot added mapQuest clean move and removed mapQuest clean move labels Dec 17, 2024
@sequestor sequestor bot added seQUESTered Identifies that an issue has been imported into Quest. and removed reQUEST Triggers an issue to be imported into Quest labels Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tdykstra tdykstra

Labels
aspnet-core/svc fundamentals/subsvc product-question seQUESTered Identifies that an issue has been imported into Quest. Source - Docs.ms Docs Customer feedback via GitHub Issue
Projects
dotnet/AspNetCore.Docs December 2024 sprint
Status: 🔖 Ready
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tdykstra @backlash1897