Update doc for clang-format and clang-tidy and correct the inconsistency between the document description and the actual formatting behavior#21
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds standalone documentation pages for the repository’s .clang-format and .clang-tidy configurations, and links them from the main README to make the style/tooling guidance easier to discover.
Changes:
- Added
clang-format.mddescribing formatting rules with config snippets and examples. - Added
clang-tidy.mddescribing the enabled/disabled check sets and recommended usage. - Updated
README.mdto link to the new configuration documentation.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
clang-tidy.md |
New doc outlining the clang-tidy whitelist strategy, enabled check groups, and examples. |
clang-format.md |
New doc describing clang-format options with examples and a reference section. |
README.md |
Adds a “配置文件” section and links to the new docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
…ang-format and documentation
0f944b2 to
f3be806
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
No description provided.