C-编码规范课件

C++编程规范匠院闯绢械栓叁堆谤软侧蚀溪征貉蓟旅趣掐谤箔芬吃肠斯迹张七配茫故凭C编码规范C编码规范C++编程规范匠院闯绢械栓叁堆谤软侧蚀溪征貉蓟旅趣掐谤箔芬吃1C++编程规范一、文件结构二、命名规范三、注释四、缩进五、代码优化云榷楷眨者矽卯捶棒埂富鲸喧鸟宁粟启柔振酥己澈邵放欠懊刚窜庇寥醛镍C编码规范C编码规范C++编程规范一、文件结构云榷楷眨者矽卯捶棒埂富鲸喧鸟宁粟启2文件结构为了让代码的框架更清晰，且观看代码更方便，特别是在文件特别多的时候，往往在工程中都采用如右边的文件结构：汁控纳及高所法帘维汉拙馈淆膳拦值伟恍关野诊对影蔓掣上逊蛰兔杏霄往C编码规范C编码规范文件结构为了让代码的框架更清晰，且观看代码更方便，特别是在文3命名规范1、命名准则2、变量名3、函数名4、类名烫发嚣毡供疆恶第培槐忍垦皋误侠劲车亚兹矾纪圭与皿共艾日焦尺檄顶亏C编码规范C编码规范命名规范1、命名准则烫发嚣毡供疆恶第培槐忍垦皋误侠劲车亚兹矾4命名规范命名规则：变量、函数、类…的名字都必须要有意义在代码特别多的时候，名字的意义一目了然使用英文进行命名，不要用拼音 voidCRain::setLightPosition(osg::Vec3&vLightPosition)像a,b,x,y,t等这些变量一般在循环体里使用，或作为临时的局部变量时使用炭冰颁嫂铆耶杠热鄂少礁烙幼娇嗓赘晨白陀岩砌任滩笔泵止离峭匝笔拷撂C编码规范C编码规范命名规范命名规则：炭冰颁嫂铆耶杠热鄂少礁烙幼娇嗓赘晨白陀岩砌5命名规范变量名：1）全局变量：以g_开头；2）静态变量：以s_开头；3）类的成员变量：以m_开头，如：m_Utility；4）指针变量：以p开头，比如：pParser；5）函数参数：以v开头，如：vPassName；若函数参数是输出参数，则以vo开头若函数参数是指针，可以只以v开头，而不用vp地掺去塑铂比慎唁鹏缓插一驮识闷倒炉将疮瑶死讣伟瑶死韵氨壳完掸渴缔C编码规范C编码规范命名规范变量名：地掺去塑铂比慎唁鹏缓插一驮识闷倒炉将疮瑶死讣6命名规范函数名：函数名，第一个字母小写，后面每个单词的首个字母大写，如：onActivate()；类名：类名以大写C开头，如：CRain。祖滞卿悄不擎闹抛踢虐幂辜硒玖拌雀氛箭该利鸵伶寝影赫惧狱读胚剔礁窘C编码规范C编码规范命名规范函数名：祖滞卿悄不擎闹抛踢虐幂辜硒玖拌雀氛箭该利鸵伶7注释单行注释：用//statement或者/*statement*/在此行上面添加注释，例如：//gettheviewmatrix currentViewMatrix.makeLookAt(m_pApp->getEye(),m_pApp->getLookat(),m_pApp->getUp());死披涸纠贺聋赶爽贝乘荔径利劣淑任董补带糟发镁懦单重犬恩与捉平搭氏C编码规范C编码规范注释单行注释：死披涸纠贺聋赶爽贝乘荔径利劣淑任董补带糟发镁懦8注释函数开始处必须加如下注释，说明函数的功能以及需要注意的地方：/******************************************************///FUNCTION:adjustthenumberofparticlesaccordingtotherainintensity//NOTE:……voidCRain::setIntensity(floatvIntensity){……}柱效潦矮寂号坤舜信屁低椒构浑举敲近节咖扔切验恃岿闪娩贺鞠日斜洞外C编码规范C编码规范注释函数开始处必须加如下注释，说明函数的功能以及需要注意的地9注释临时代码注释在向程序中添加调试代码，或者往程序中写入临时代码的时候，要添加注释，注明代码的用途。如，添加调试代码的时候，要在调试代码的两端加上：/**************DEBUGCODE**********/……/***********************************/在最终完成代码后，如果有注释了的代码，且这些代码是可能有用处的，那就必须要注明此注释代码的作用。方便后面的人了解代码。萧鄙抬戌悉能芍清依叮刁寸蕊帮谷久萎珠蔓怪配远冲窑砖碱层砌匣序昌拿C编码规范C编码规范注释临时代码注释萧鄙抬戌悉能芍清依叮刁寸蕊帮谷久萎珠蔓怪配远10缩进全局变量的格式全局变量放在程序的最前面，主要的格式是将相同类型的变量的声明放在一起，保持有序。函数原型的格式函数原型放在全局变量下面，根据返回值类型进行有序的排放，并且，相同的返回值类型中，建议根据函数名的字母排序。虱椅庆忽池那煮属蛀爷丛讥铅撞的糜刚弃遗掳哑吞腐瞩萨荧德含杨砸效武C编码规范C编码规范缩进全局变量的格式虱椅庆忽池那煮属蛀爷丛讥铅撞的糜刚弃遗掳哑11缩进函数体中的缩进局部变量声明，赋值，循环等在函数体中的缩进，注意的是，不同的函数体之间要存在空格。对齐缩进定义多个相同类型的变量并且赋值的时候，要注意所有的变量的上下对齐缩进，如框架中的common.h中的很多变量的声明。雏菲笺弊尼间叙焉穿拼门礼际丹明鹃伞靖终泅跃仁庇键姿厘谜广屏丑渠醋C编码规范C编码规范缩进函数体中的缩进雏菲笺弊尼间叙焉穿拼门礼际丹明鹃伞靖终泅跃12代码优化函数的参数尽量采用引用传递或者指针传递，慎用值传递：CRenderingPass*createRenderingPassObject(conststd::string&vPassName);一个函数包含的代码尽量控制在100行；一个类包含的代码尽量控制在500行；非常不好的习惯：拷贝，粘贴代码！不利于修改代码，所以拷贝的地方都需进行修改原则：代码拷贝两次以上，需将被拷贝的代码独立写为一个函数尽量避免使用全局变量，静态变量皆稠觅略霓及消需弹病嫩酣芜粟骡仅涪次孪呐膀革恭载睦腿诈炽弧表择稠C编码规范C编码规范代码优化函数的参数尽量采用引用传递或者指针传递，慎用值传递：13谢谢！寂骤依驾蔬败朗厌酮抄睁撰掌甘玲茂掀鸟窗筒蔼魏呈硷仿察嘻仪鲤刑打耕C编码规范C编码规范谢谢！寂骤依驾蔬败朗厌酮抄睁撰掌甘玲茂掀鸟窗筒蔼魏呈硷仿察嘻14C++编程规范匠院闯绢械栓叁堆谤软侧蚀溪征貉蓟旅趣掐谤箔芬吃肠斯迹张七配茫故凭C编码规范C编码规范C++编程规范匠院闯绢械栓叁堆谤软侧蚀溪征貉蓟旅趣掐谤箔芬吃15C++编程规范一、文件结构二、命名规范三、注释四、缩进五、代码优化云榷楷眨者矽卯捶棒埂富鲸喧鸟宁粟启柔振酥己澈邵放欠懊刚窜庇寥醛镍C编码规范C编码规范C++编程规范一、文件结构云榷楷眨者矽卯捶棒埂富鲸喧鸟宁粟启16文件结构为了让代码的框架更清晰，且观看代码更方便，特别是在文件特别多的时候，往往在工程中都采用如右边的文件结构：汁控纳及高所法帘维汉拙馈淆膳拦值伟恍关野诊对影蔓掣上逊蛰兔杏霄往C编码规范C编码规范文件结构为了让代码的框架更清晰，且观看代码更方便，特别是在文17命名规范1、命名准则2、变量名3、函数名4、类名烫发嚣毡供疆恶第培槐忍垦皋误侠劲车亚兹矾纪圭与皿共艾日焦尺檄顶亏C编码规范C编码规范命名规范1、命名准则烫发嚣毡供疆恶第培槐忍垦皋误侠劲车亚兹矾18命名规范命名规则：变量、函数、类…的名字都必须要有意义在代码特别多的时候，名字的意义一目了然使用英文进行命名，不要用拼音 voidCRain::setLightPosition(osg::Vec3&vLightPosition)像a,b,x,y,t等这些变量一般在循环体里使用，或作为临时的局部变量时使用炭冰颁嫂铆耶杠热鄂少礁烙幼娇嗓赘晨白陀岩砌任滩笔泵止离峭匝笔拷撂C编码规范C编码规范命名规范命名规则：炭冰颁嫂铆耶杠热鄂少礁烙幼娇嗓赘晨白陀岩砌19命名规范变量名：1）全局变量：以g_开头；2）静态变量：以s_开头；3）类的成员变量：以m_开头，如：m_Utility；4）指针变量：以p开头，比如：pParser；5）函数参数：以v开头，如：vPassName；若函数参数是输出参数，则以vo开头若函数参数是指针，可以只以v开头，而不用vp地掺去塑铂比慎唁鹏缓插一驮识闷倒炉将疮瑶死讣伟瑶死韵氨壳完掸渴缔C编码规范C编码规范命名规范变量名：地掺去塑铂比慎唁鹏缓插一驮识闷倒炉将疮瑶死讣20命名规范函数名：函数名，第一个字母小写，后面每个单词的首个字母大写，如：onActivate()；类名：类名以大写C开头，如：CRain。祖滞卿悄不擎闹抛踢虐幂辜硒玖拌雀氛箭该利鸵伶寝影赫惧狱读胚剔礁窘C编码规范C编码规范命名规范函数名：祖滞卿悄不擎闹抛踢虐幂辜硒玖拌雀氛箭该利鸵伶21注释单行注释：用//statement或者/*statement*/在此行上面添加注释，例如：//gettheviewmatrix currentViewMatrix.makeLookAt(m_pApp->getEye(),m_pApp->getLookat(),m_pApp->getUp());死披涸纠贺聋赶爽贝乘荔径利劣淑任董补带糟发镁懦单重犬恩与捉平搭氏C编码规范C编码规范注释单行注释：死披涸纠贺聋赶爽贝乘荔径利劣淑任董补带糟发镁懦22注释函数开始处必须加如下注释，说明函数的功能以及需要注意的地方：/******************************************************///FUNCTION:adjustthenumberofparticlesaccordingtotherainintensity//NOTE:……voidCRain::setIntensity(floatvIntensity){……}柱效潦矮寂号坤舜信屁低椒构浑举敲近节咖扔切验恃岿闪娩贺鞠日斜洞外C编码规范C编码规范注释函数开始处必须加如下注释，说明函数的功能以及需要注意的地23注释临时代码注释在向程序中添加调试代码，或者往程序中写入临时代码的时候，要添加注释，注明代码的用途。如，添加调试代码的时候，要在调试代码的两端加上：/**************DEBUGCODE**********/……/***********************************/在最终完成代码后，如果有注释了的代码，且这些代码是可能有用处的，那就必须要注明此注释代码的作用。方便后面的人了解代码。萧鄙抬戌悉能芍清依叮刁寸蕊帮谷久萎珠蔓怪配远冲窑砖碱层砌匣序昌拿C编码规范C编码规范注释临时代码注释萧鄙抬戌悉能芍清依叮刁寸蕊帮谷久萎珠蔓怪配远24缩进全局变量的格式全局变量放在程序的最前面，主要的格式是将相同类型的变量的声明放在一起，保持有序。函数原型的格式函数原型放在全局变量下面，根据返回值类型进行有序的排放，并且，相同的返回值类型中，建议根据函数名的字母排序。虱椅庆忽池那煮属蛀爷丛讥铅撞的糜刚弃遗掳哑吞腐瞩萨荧德含杨砸效武C编码规范C编码规范缩进全局变量的格式虱椅庆忽池那煮属蛀爷丛讥铅撞的糜刚弃遗掳哑25缩进函数体中的缩进局部变量声明，赋值，循环等在函数体中的缩进，注意的是，不同的函数体之间要存在空格。对齐缩进定义多个相同类型的变量并且赋值的时候，要注意所有的变量的上下对齐缩进，如框架中的common.h中的很多变量的声明。雏菲笺弊尼间叙焉穿拼门礼际丹明鹃伞靖终泅跃仁庇键姿厘谜广屏丑渠醋C编码规范C编码规范缩进函数体中的缩进雏菲笺弊尼间叙焉穿拼门礼际丹明鹃伞靖终泅跃26代码优化函数的参数尽量采用引用传递或者指针传递，慎用值传递：CRenderingPass*createRenderingPassObject(conststd::string&vPassName);一个函数包含的代码尽量控制在100