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

[Syntax] Comments syntax is not fully homogeneous in the current code base. #40

Open
Tracked by #74
jalinei opened this issue May 2, 2024 · 0 comments
Open
Tracked by #74
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request Low priority
Milestone

Comments

@jalinei
Copy link
Contributor

jalinei commented May 2, 2024

We need a clear coding guideline for comment syntax.

In some files we do have both /* syntax and // syntax.
For me it is not fully clear why we have both.
Comments also might be either on the .h or the .c. We have to harmonize this in each module.

Action

  • Decide on common coding guideline for comments
    • Proposal : all functions comments in .h files
    • Proposal : have only /* foobar */ comments as per zephyr coding guidelines.
  • Make sure it is compliant with vscode javadocs tooltips.
@jalinei jalinei added documentation Improvements or additions to documentation enhancement New feature or request Low priority labels May 2, 2024
@jalinei jalinei added this to the V1.0 milestone May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request Low priority
Projects
None yet
Development

No branches or pull requests

4 participants