| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
[docs]: 新增C++通用编码规范三条规则 Co-authored-by: lining23666<lining.li@huawei.com> # message auto-generated for no-merge-commit merge: !781 merge docs/add-cpp-general-rules into master [docs]: 新增C++通用编码规范三条规则 Created-by: lining23666 Commit-by: lining23666 Merged-by: cann-robot Description: **提交 PR 前，请先阅读 [HIXL贡献指南](https://gitcode.com/cann/hixl/blob/master/CONTRIBUTING.md) ，查看 PR 提交方式并遵守相关提交规范。** ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 代码重构 - [x] 文档更新 - [ ] 其他，请描述： ## 描述 <!--简要描述本次改动的背景，包括改动的原因、解决的问题等。--> 在 docs/zh 和 docs/en 的 contributions/coding_standards/cpp-general.md 中同步新增三条 C++ 通用编码规范，供 hixl-pr-review 检视时参照执行： 1. **规则 13.4 不会修改成员变量的成员函数必须使用 const 修饰**（类和对象）：const 成员函数向调用者承诺不修改对象状态，是 const-correctness 的基础。样例展示 getter 返回 const std::string & 并加 const 修饰的正反例。 2. **建议 13.5 禁止从析构函数中抛出异常**（类和对象）：C++11 起析构函数默认 noexcept，抛异常会触发 std::terminate 导致程序崩溃。样例展示在析构函数内部捕获并记录日志的正确做法。 3. **建议 15.8 函数的所有声明必须与定义具有一致的参数名**（函数使用）：C++ 标准不要求一致，但不一致会降低可读性。适用于所有 C++ 函数，声明中省略参数名不视为不一致。 三条规则均标记为 SUSPICIOUS 级别，样例统一采用下划线命名风格。hixl-pr-review 下次检视时会自动将这三条纳入「C++ 通用编码规范检查」表格输出，无需改 skill 代码。 ## 测试项 <!--描述进行了哪些测试来验证本次改动，或新增了哪些测试用例。--> - 对中英文文档改动运行 pre-commit run --files，全部 hook（trailing-whitespace、end-of-file-fixer、codespell、OAT 合规检查等）通过。 - 人工核对中英文内容一致、表格编号连续、Markdown 语法正确。 ## 测试结果 <!--描述上述测试项的测试结果，可通过表格、图片等形式展示。--> - pre-commit 全部 Passed，OAT 合规检查 [OK] All checks passed (2 file(s) checked)。 - 中英文文档规则条目、编号、正反例代码块一一对应。 ## Checklist <!-- [x] 表示选中 --> - [x] 该Pull Request的代码风格和项目的代码风格一致 - [x] 提交的代码已经过充分的验证 - [x] 涉及的相关文档修改已更新 - [x] 标题中正确使用了类型标签（例如：feat/bugfix/refactor/docs/test等） ## 其它（可选） <!--可以在这里描述任何和该Pull Request相关的说明。--> 本次新增的三条规则在讨论中确定：13.4/13.5 归入第13章「类和对象」（与 13.3 virtual/override/final 同属成员函数限定符主题），15.8 归入第15章「函数使用」（与 15.1/15.2 参数一致性主题相邻）。规则强度均定为 SUSPICIOUS，与近期新增规则保持一致，渐进推行。 See merge request: cann/hixl!781 | 4 天前 | |
[docs]:文档整改 Co-authored-by: tangjie66<tangjie66@huawei.com> # message auto-generated for no-merge-commit merge: !734 merge dochixl into master [docs] 文档整改 Created-by: tangjie66 Commit-by: tangjie66 Merged-by: cann-robot Description: **提交 PR 前，请先阅读 [HIXL贡献指南](https://gitcode.com/cann/hixl/blob/master/CONTRIBUTING.md) ，查看 PR 提交方式并遵守相关提交规范。** ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 代码重构 - [x] 文档更新 - [ ] 其他，请描述： ## 描述 <!--简要描述本次改动的背景，包括改动的原因、解决的问题等。--> 文档内容优化 https://gitcode.com/cann/hixl/issues/420 https://gitcode.com/cann/hixl/issues/419 https://gitcode.com/cann/hixl/issues/418 ## 测试项 <!--描述进行了哪些测试来验证本次改动，或新增了哪些测试用例。--> ## 测试结果 <!--描述上述测试项的测试结果，可通过表格、图片等形式展示。--> ## Checklist <!-- [x] 表示选中 --> - [x] 该Pull Request的代码风格和项目的代码风格一致 - [x] 提交的代码已经过充分的验证 - [x] 涉及的相关文档修改已更新 - [x] 标题中正确使用了类型标签（例如：feat/bugfix/refactor/docs/test等） ## 其它（可选） <!--可以在这里描述任何和该Pull Request相关的说明。--> See merge request: cann/hixl!734 | 18 天前 |
| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
| 4 天前 | ||
| 18 天前 |