From 0761daec0b5c5cfb721cfdb412c0717544c933e6 Mon Sep 17 00:00:00 2001 From: fslongjin Date: Thu, 28 Jul 2022 10:40:16 +0800 Subject: [PATCH] =?UTF-8?q?=E5=AE=8C=E5=96=84=E5=91=BD=E5=90=8D=E8=A7=84?= =?UTF-8?q?=E5=88=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/community/code_contribution/coding-style.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/community/code_contribution/coding-style.md b/docs/community/code_contribution/coding-style.md index ece8d3e0..0cae2bfb 100644 --- a/docs/community/code_contribution/coding-style.md +++ b/docs/community/code_contribution/coding-style.md @@ -142,5 +142,17 @@ void *func(char* s, int **p); ```c ++ -- . -> ``` +## 4. 命名 + +  DragonOS中的命名规范不使用诸如`TempValue`这样的驼峰命名法的函数名，而是使用`tmp`这样言简意赅的命名。 + +  注意，这里指的是我们在整个项目内都不希望使用驼峰命名法。并不意味着程序员可以随便的使用一些难以理解的缩写来作为变量名。 + +  对于全局变量或者全局可见的函数、结构体而言，我们需要遵循以下的命名规定： +- 名称需要易于理解，且不具有歧义。如：对于一个计算文件夹大小的函数而言，我们建议使用`count_folder_size()`来命名，而不是`cntfs()`这样令其他人头大的命名。 +- 全局的，非static的名称，除非有特别的必要，命名时需要遵循以下格式：`模块名缩写前缀_函数/变量名`。这样的命名能便于别人区分这个名称位于哪个模块内，也减少了由于命名冲突所导致的麻烦。 +- 不需要让其他代码文件可见的全局名称，必须添加`static`修饰符。 + +  对于函数内的局部变量而言，命名规范则是需要言简意赅。过长的名称在局部变量中没有太大的意义。 【文档未完成，待继续完善】 \ No newline at end of file