SuperAPI AI 工具集

code-quality

编程与开发

查看项目

更新于 10-16 06:51

技能介绍

用途:在提交改动前检查代码风格、运行 pre-commit 钩子,确保代码符合 Google C++ Style Guide。

代码风格:遵循 Google C++ Style Guide;每行最多 120 字符;缩进 4 个空格;配置文件为仓库根目录的 .clang-format。

安装与启用钩子: pip3 install pre-commit pre-commit install --hook-type pre-commit --hook-type pre-push

使用方式: pre-commit run pre-commit run --files src/index/hnsw/hnsw.cc include/knowhere/index/index.h pre-commit run --all-files

提交流程:先修改代码,再对改动文件运行 pre-commit run --files <changed-files>,然后 git add . 与 git commit -m "message"。钩子会在提交时自动运行,推送前需修复所有失败项。

常见问题:格式错误可运行 clang-format -i <file> 或让 pre-commit 自动修复;行过长需在逻辑点换行,最多 120 字符;include 顺序遵循 Google 风格:相关头文件、C 系统头、C++ 标准库、其他库、项目头文件。

限制:资料未提供其他平台支持、收费或价格信息。