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.

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

Naming style for static members contradicts with the page "Names of Type Members" #30642

Closed
fgimian opened this issue Aug 12, 2022 · 2 comments · Fixed by #36428
Closed

Naming style for static members contradicts with the page "Names of Type Members" #30642

fgimian opened this issue Aug 12, 2022 · 2 comments · Fixed by #36428
Assignees
Labels
doc-enhancement Improve the current content [org][type][category] dotnet-csharp/svc fundamentals/subsvc Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.

Comments

@fgimian
Copy link

fgimian commented Aug 12, 2022

This page suggests using a s_ prefix for static members yet the Names of Type Members docs specifically say:

For example, do not use "g_" or "s_" to indicate static fields.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.


Associated WorkItem - 123087

@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Aug 12, 2022
@issues-automation issues-automation bot added fundamentals/subsvc dotnet-csharp/svc Pri1 High priority, do before Pri2 and Pri3 labels Aug 12, 2022
@BillWagner BillWagner added the doc-enhancement Improve the current content [org][type][category] label Aug 12, 2022
@dotnet-bot dotnet-bot removed the ⌚ Not Triaged Not triaged label Aug 12, 2022
@BillWagner
Copy link
Member

This is an area we should look at more holistically.

In general, our docs follow the dotnet/runtime coding style. We should update these articles to match that, and point liberally to the editorconfig section of the Visual Studio docs to enable each team to enforce their preferences.

@fgimian
Copy link
Author

fgimian commented Aug 13, 2022

This is an area we should look at more holistically.

In general, our docs follow the dotnet/runtime coding style. We should update these articles to match that, and point liberally to the editorconfig section of the Visual Studio docs to enable each team to enforce their preferences.

Sounds good, thanks so much. I think clarifying this consistently would be good. Unfortunately some of these conventions also don't align with StyleCop defaults which makes it a little more confusing for someone who isn't as familiar with the language.

Kindest Regards
Fotis

@BillWagner BillWagner self-assigned this Jun 30, 2023
@BillWagner BillWagner added the 🗺️ reQUEST Triggers an issue to be imported into Quest. label Jun 30, 2023
@github-actions github-actions bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Jul 1, 2023
@BillWagner BillWagner moved this from 🔖 Ready to 🏗 In progress in dotnet/docs July 2023 sprint Jul 24, 2023
@BillWagner BillWagner moved this from 🏗 In progress to 👀 In review in dotnet/docs July 2023 sprint Jul 27, 2023
BillWagner added a commit to BillWagner/docs that referenced this issue Jul 27, 2023
Fixes dotnet#30626: Clarify (again) that these are our guidelines, not yours. Point out that it's not the VS default, but a configuration option.
Fixes dotnet#30642: Again, our style.
Fixes dotnet#30799: Change constant style from ALL_CAPS to PascalCase to match runtime repo.
Fixes dotnet#33959: Update variable names so delegate types are PascalCased and instances of a delegate are camelCase. Add clarifying text for the same.
@ghost ghost added the in-pr This issue will be closed (fixed) by an active pull request. label Jul 27, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in dotnet/docs July 2023 sprint Jul 31, 2023
@ghost ghost removed the in-pr This issue will be closed (fixed) by an active pull request. label Jul 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement Improve the current content [org][type][category] dotnet-csharp/svc fundamentals/subsvc Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants