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

Update PackageVersion comments to use /** */ form instead of /// form #3577

Closed
LarryOsterman opened this issue Apr 21, 2022 · 3 comments · Fixed by #4063
Closed

Update PackageVersion comments to use /** */ form instead of /// form #3577

LarryOsterman opened this issue Apr 21, 2022 · 3 comments · Fixed by #4063
Assignees
Labels
Azure.Core Client This issue points to a problem in the data-plane of the library. feature-request This issue requires a new behavior in the product in order be resolved.

Comments

@LarryOsterman
Copy link
Member

LarryOsterman commented Apr 21, 2022

The following azure packages have /// form comments in their package_version.hpp file:
X * Azure::Attestation
X* Azure::Core
X* Azure::Identity
X* Azure::Keyvault::Secrets
X* Azure::Keyvault::Keys
X* Azure::Keyvault::Certificates
X* Azure::Storage::Blobs
X* Azure::Storage::Common
X* Azure::Storage::Files::Datalake
X* Azure::Storage::Files::Shares
X* Azure::Storage::Queues
X* Azure::Template

They should be updated to reflect coding guidelines and use the /** */ form of comments.

Originally posted by @LarryOsterman in #3561 (comment)

@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Apr 21, 2022
@Jinming-Hu
Copy link
Member

What's the motivation of this proposal?

Javadoc style comments (/** */) are for doxygen docs. If I write some comments just for developers to better understand the code logic, it shouldn't be reflected in doxygen docs.

@LarryOsterman
Copy link
Member Author

I'm going to let @gearama comment on the motivation. He's the one who raised the issue of /// doxygen comments in a code review.

I'm just the messenger here.

@Jinming-Hu
Copy link
Member

Okay, so you are not talking about all the comments, just doxygen comments.

There are four styles listed in the manual https://www.doxygen.nl/manual/docblocks.html. If you're only talking about doxygen comments, then I agree, we should have consistent style.

@RickWinter RickWinter added feature-request This issue requires a new behavior in the product in order be resolved. Azure.Core Client This issue points to a problem in the data-plane of the library. labels Apr 22, 2022
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Apr 22, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Azure.Core Client This issue points to a problem in the data-plane of the library. feature-request This issue requires a new behavior in the product in order be resolved.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants