C语言 各种名称命名规范(以便保持风格 方便后期阅读代码)简约版
项目变量、结构体、函数、文件命名规则


基本命名规则


除了'.' '/' '\' ,其他符号均属合法字符,尽量让所有命名有其意义,容易看懂是最好的命名



一、变量规则


(1)全局结构体(以"_t"结尾)
例如:typedef struct{ }student_t;

(2)全局变量(以"_g"结尾)
例如:int sum_g = 0;

(3)全局指针变量(以"_p"结尾)
例如:int *flag_p = NULL;

(4)常量/宏(大写和下划线构成)
例如:#define MAX_NUM (100)
int MIN_NUM = 20;


(其他)遵循基本命名规则;

二、函数规则


(1)基本函数(下划线分割标准)
例如:copy_to_user();

(2)初始化函数(以"_init"结尾)
例如:sock_can_init();

(3)中断处理函数(以"_isr"结尾)
例如:key_isr();

(4)大括号风格
例如:函数如:
func()
{

}

if(){

}

(其他)遵循基本函数命名规则

三、文件规则


(1).c .h (下划线分割标准)
例如:socket_can.c

(2)工程文件夹名(小写工程名)
例如:server

(3)可执行文件
一般:
"a.out"
特殊:
ARM平台:"XX_ARM"
X86平台: "XX_x86"


(4)README("README.txt")

(5)头文件卫士
例如:#ifndef _LED_H_
#define _LED_H_
#endif //_LED_H_

(其他)遵循基本命名规则;

四、软件版本命名规则


<软件名称>_<主版本号>.<子版本号>.<阶段版本号>._<日期版本号>_<希腊字母版本号>
例如:server_1.1.0_180503_alpha


 希腊字母所代表的版本阶段介绍

alpha版:主要是以实现软件功能为主,通常只在软件开发者内部交流,

                                          一般而言,该版本软件的Bug较多,需要继续修改。

beta版:此版本主要的修改对像是软件的UI。
rc版:基本上不存在导致错误的BUG,与即将发行的正式版相差无几,测试通过
release版:“最终版本”、“上线版本”

版本号修改规则
以 server_1.1.0_180503_alpha 为例
主版本号(1):软件框架发生变化 模块添加
子版本号(1):模块功能有一定增加或变化
阶段版本号(0):修复bug 或小变化
日期版本号(180503):此版本修改日期
希腊字母版本号(alpha):表明项目进行阶段



阅读更多
个人分类: 规范
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

不良信息举报

C语言 各种名称命名规范(以便保持风格 方便后期阅读代码)简约版

最多只允许输入30个字

加入CSDN,享受更精准的内容推荐,与500万程序员共同成长!
关闭
关闭