《qt编程规范.pdf》由会员分享,可在线阅读,更多相关《qt编程规范.pdf(4页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、编程规范一注释规范.1 文件注释.1 结构体/类注释 .1 函数注释.2 变量注释.2 二变量命名.3 工程命名.3 文件命名.3 类/结构体命名 .3 函数命名.3 变量命名.4 三编程风格.4 四英文单词参考.4注:程序中所有的文字描述都是用英文,即整个代码文件不能出现中文一注释规范文件注释位置:开始一个文件前格式:/*文件名*编制日期,作者*注释内容*/举例:/*main.c*implement main-loop*implement message management*/结构体/类注释位置:声明一个结构体/类前格式:/*结构体/类名*注释内容*注释内容*/struct/class N
2、ame ;举例:/*main.c*implement main-loop*implement message management*/函数注释位置:开始一个函数前(头文件中可不注释,只注释实现文件)格式:/*函数名 brief 概要描述*param 类型,注释 param;类型,注释(输入参数注释,按照参数列表顺次注释)*retval 类型,注释(返回值注释)*/举例:/*mmTest()brief memory malloc test*param char*,address of memory;int size,length of malloc*retval void,no return v
3、alue*/void mmTest(char*buffer,int size)变量注释位置:定义一个变量时格式:/*简要注释*/或/简要注释举例:int size/*memory malloc test*/或者int size/memory malloc test 二变量命名工程命名1)由多个单词拼装表达意思时,每个单词首字母大写2)单词间不允许出现空格、连字符“-”、正反斜杠3)推荐只是用26 个字母举例:SmartHome(智能家居)文件命名1)必须全部为小写字母,后缀为“.c”2)单词间不允许出现空格、连字符“-”、正反斜杠3)推荐只是用26 个字母举例:main.c mymain.c
4、类/结构体命名1)由多个单词拼装表达意思时,每个单词首字母大写,前缀为“class/struct”2)单词间不允许出现空格、连字符“-”、正反斜杠3)推荐只是用26 个字母举例:struct SmartHome 函数命名1)由多个单词拼装表达意思时,从第二个单词开始首字母大写2)单词间不允许出现空格、连字符“-”、正反斜杠3)推荐只是用26 个字母举例:void mmTest(char*buffer,int size)void test(char*buffer,int size)变量命名1)所有变量都必须纯小写,多个单词拼接时可以用下滑线隔开;2)全局变量以“g_”开始;3)局部变量以“l_”
5、开始;4)临时变量、函数参数、结构体/类成员等无前缀;5)推荐只是用26 个字母举例:int g_a;int test(int a)int l_b;*int temp;for(temp=0;temp10;temp+)return 0;三编程风格/*注释;*/struct SmartHome 代码;/注释;四英文单词参考1.实现:implement/realize 2.完成:complete 3.智能:smart 4.插座:socket 5.安防:safeguard 6.家电:appliance 7.美的:Midea 8.控制中心:CC(control center)9.智能终端:ST(smart terminal)10.洗碗机:dishwasher 11.洗衣机:washer 12.空调:AC(air-condition)13.空调扇:AF(air-fan)14.机顶盒:STB(set-top-box)15.窗帘:curtain 16.电灯:lamp 17.电:electricity 18.协议:protocol 19.智能家居:smarthome