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

Remove @ tag from all comments #2226

Merged
merged 1 commit into from
Jan 4, 2024
Merged

Conversation

xiaoxiang781216
Copy link
Contributor

Summary

and format the multiple line comments

Impact

format change only

Testing

ci

and format the multiple line comments

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
@yamt
Copy link
Contributor

yamt commented Dec 28, 2023

Remove @ tag from all comments

why?

@xiaoxiang781216
Copy link
Contributor Author

Remove @ tag from all comments

why?

Because all NuttX native comments don't use @, which are copied from other code base to identify the special element.

@yamt
Copy link
Contributor

yamt commented Dec 28, 2023

Remove @ tag from all comments

why?

Because all NuttX native comments don't use @, which are copied from other code base to identify the special element.

well, what's the benefit we can gain by removing them?
i feel doxygen style comments are popular enough.

@xiaoxiang781216
Copy link
Contributor Author

Remove @ tag from all comments

why?

Because all NuttX native comments don't use @, which are copied from other code base to identify the special element.

well, what's the benefit we can gain by removing them?

Improve the consistency.

i feel doxygen style comments are popular enough.

It isn't popular in NuttX code base.

Copy link
Contributor

@yamt yamt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i feel it makes sense for us to allow doxygen or some other structured comment style in future.

@pkarashchenko pkarashchenko merged commit e55c0d9 into apache:master Jan 4, 2024
@xiaoxiang781216 xiaoxiang781216 deleted the style branch January 4, 2024 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants