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

Format Comments Consistently in P4C. #4567

Closed
sumit7754 opened this issue Mar 27, 2024 · 0 comments · Fixed by #4602, #4603 or #4619
Closed

Format Comments Consistently in P4C. #4567

sumit7754 opened this issue Mar 27, 2024 · 0 comments · Fixed by #4602, #4603 or #4619
Assignees
Labels
enhancement This topic discusses an improvement to existing compiler code.

Comments

@sumit7754
Copy link
Contributor

This issue aims to address the lack of consistency in comment formatting across the core parts of the P4C compiler. Following a discussion in #4563, it has been suggested to adopt a unified commenting style: using triple slashes (///) for documenting functions and classes, and double slashes (//) for comments within code. This approach aligns with the recommendation provided in the Doxygen documentation.

@fruffy fruffy changed the title Consistent Comment Formatting for P4c Format Comments Consistently in P4C. Mar 27, 2024
@fruffy fruffy added the enhancement This topic discusses an improvement to existing compiler code. label Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This topic discusses an improvement to existing compiler code.
Projects
None yet
2 participants