docs: add .clangd template and configuration guide

Signed-off-by: Ziy1-Tan <ajb459684460@gmail.com>
opencurve · Feb 7, 2023 · 371ff15 · 371ff15
1 parent 3050265
commit 371ff15
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 5 deletions.
diff --git a/.clangd b/.clangd
@@ -0,0 +1,12 @@
+Diagnostics:
+  ClangTidy:
+    Add: [performance-*, modernize-*, readability-*,bugprone-*,]
+    Remove: [modernize-use-trailing-return-type]
+    CheckOptions:
+      readability-identifier-naming.VariableCase: camelBack
+  UnusedIncludes: Strict
+
+InlayHints:
+  Enabled: No
+  ParameterNames: No
+  DeducedTypes: No
diff --git a/.gitignore b/.gitignore
@@ -78,6 +78,7 @@ runlog/
 .gdb_history
 
 .clang-format
+.clangd
 !curve-snapshotcloneserver-nginx/app/lib
 !nebd/nebd-package/usr/bin
 

diff --git a/docs/cn/clangd.md b/docs/cn/clangd.md
@@ -46,13 +46,13 @@
           readability-identifier-naming.VariableCase: camelBack
      UnusedIncludes: Strict
    
-   # 下面几个可以设置为True，可以在对应的地方显示函数形参名称和auto推导出的类型
+   # 下面几个可以设置为Yes，可以在对应的地方显示函数形参名称和auto推导出的类型
    InlayHints:
-     Enabled: False
-     ParameterNames: False
-     DeducedTypes: False
+     Enabled: No
+     ParameterNames: No
+     DeducedTypes: No
    ```
-
+配置文件功能是clangd 11新增的，请升级您的clangd版本
 ### clangd 官网
 
 https://clangd.llvm.org/installation