背景
刚开始工作的时候,变量命名很不规范,注释也很随意,后来时间一久就成了屎山代码。和同事交接工作的时候很尴尬。后来总结了一套简洁的规范。既能规范代码,使用起来也不繁琐。
c语言编程规范
- 函数和变量名应该具有描述性,使用有意义的名字。
- 函数名应该用小写字母开头,并使用下划线分隔单词,除特殊单词外,都是用小写。
- 文件名应该用小写字母开头,并使用下划线分隔单词,除特殊单词外,都是用小写。
- 全局变量应该以"g_"开头。
- 静态变量应该以"s_"开头。
- 常量应该全部大写,并使用下划线分隔单词。
- 宏定义应该全部大写,并使用下划线分隔单词。
- 指针变量应该在其类型前加上"p_“,全局指针变量用"gp_”。
- 数组应该在其名字后加上"_arr"。
- 类型替代同义字后加上"_t"。
- 注释需要统一,所有的变量定义、常量定义、文件描述、函数注释都需要注释,并按下面的规则。
- TAB缩进统一为4个空格
- 双目运算符如 “=”, “+=”,“>=”, “<=”, “+”, “&&”, “<<”, “^”等的两侧需要留有空格
- 禁止使用魔数。详情见:魔数百度百科
代码实操
//文件描述注释规范
/*
* @Author: 莲花码农 //作者名
* @Date: 2024-07-11 12:21:49 //文件创建时间
* @LastEditTime: 2024-07-13 10:52:13 //文件修改时间
* @LastEditors: 莲花码农 //文件修改作者
* @Version: 1.0.0 //版本号
* @Description: 外部中断 //文件描述
* @FilePath: Projects\src\bsp_io.c //文件路径
* Copyright (c) 2024 莲花码农 //版权声明
*/
// 全局变量命名规范
int g_global_variable = 0;
// 静态变量
static int s_static_variable = 0;
// 常量1命名规范
#define MAX_VALUE 100
// 常量2命名规范
const int MAX_COUNT = MAX_VALUE;
// 全局指针命名规范
char* gp_str = "Hello, World!\n"
// 数组命名规范
int g_global_variable_arr[MAX_VALUE];
// 类型替代同义字命名规范
typedef struct
{
int var;
}variable_t;
// 函数命名规范
void print_message()
{
// 局部指针命名规范
char* p_str = "Hello, World!\n"
printf(p_str);
}
//函数注释规范
/**
* @brief 打印数字
* @param {uint32_t } var:要打印的值
* @retval 1:成功
*/
int print_message_hex(uint32_t var)
{
printf("Hello,%d!\n",var);
return 1;
}
总结
程序命名规范在软件开发中扮演着至关重要的角色,它们不仅影响着代码的可读性、可维护性,还直接关系到团队协作的效率和项目的长期成功。指定程序命名规范的意义主要体现在以下几个方面:
- 提高代码可读性:良好的命名规范使得代码易于理解。通过遵循一致的命名约定,开发者可以迅速理解变量、函数、类等元素的用途和目的,而无需深入查看其实现细节。这有助于减少阅读代码时的困惑和误解。
- 促进团队协作:在团队开发环境中,不同的开发者可能会参与到同一个项目的不同部分。统一的命名规范有助于确保团队成员之间的代码风格一致,减少因个人习惯差异导致的混乱。这有助于团队成员更好地协作,提高开发效率。
- 增强代码可维护性:随着时间的推移,软件项目可能会经历多次迭代和修改。良好的命名规范使得代码在修改和扩展时更加容易理解和维护。当需要修改或添加新功能时,开发者可以更快地找到相关的代码段,并理解其上下文和逻辑。
- 避免命名冲突:在大型项目中,可能会存在大量的变量、函数和类等元素。遵循命名规范有助于减少命名冲突的可能性,确保每个元素都有一个唯一且易于识别的名称。
- 提高代码质量:命名规范是代码质量的一个重要方面。通过遵循良好的命名习惯,开发者可以编写出更加清晰、简洁和高效的代码。这有助于提高软件的整体质量和可靠性。
- 促进代码重用:良好的命名规范有助于促进代码的重用。当开发者需要实现某个功能时,他们可以通过搜索具有描述性名称的函数、类或模块来找到可重用的代码段。这有助于减少重复劳动,提高开发效率。
- 符合行业标准和最佳实践:许多行业都制定了自己的编程标准和最佳实践,其中包括命名规范。遵循这些标准和最佳实践有助于使项目更加符合行业标准,提高项目的专业性和可信度。
综上所述,指定程序命名规范对于提高代码质量、促进团队协作、增强代码可维护性和可读性等方面都具有重要意义。因此,在软件开发过程中,应该重视命名规范的制定和执行。