c++编程规范
1. 命名规范
(1)命名示例:
Class_Name、 struct_name、union_name、enum_name、typedef_name、variable_name、const_name、define_name、macro_name、func_name、param_name等。
(2)所有命名均采用以下统一的规范:
(a)类名和宏定义以大写字母开头,其他命名均以小写字母开头。
(b)使用下划线分隔多个单词,且整体字母采用小写。
(3)文件名也应遵循上述规范,可以使用下划线将多个单词组合。
2.排版风格
(1)所有排版风格均以4个空格进行缩进,而不是使用Tab键;
(2)变量名和函数名之间至少要有一个空格;
(3)“=”以及“=>”等赋值操作符左右各要一个空格;
(4)布尔类型表达式中“&&”以及“||“应该被包括在一对空格中;
(5)使用花括号时,左大括号要放在同一行,右大括号要放在新的一行,在这两行之间可以放置一个空行。
3.注释规范
(1)函数注释:每个函数之前应有函数名,参数,返回值及功能等简要描述;
param name (2)代码注释:可在待解释的代码上一行进行注释,同一行不宜有多条注释;
(3)块注释:可用来注释段落的printf语句,多行的循环结构等;
(4)文档模板:使用多文档模板注释你的函数,以方便阅读和维护。
4.变量
(1)本地变量的命名应尽量有意义;
(2)避免使用一个字母,它只能是一个最简单的变量;
(3)使用符合驼峰原则定义变量,先使用名词,然后加上形容词,以描述变量的作用;
(4)变量使用最为简洁的表达,避免用过长或过短的变量名称;
(5)决不使用系统保留字作为变量名称,有强烈反对意见的单词也不建议使用作为变量名称;
(6)尽量避免多意义的变量名;
(7)在同一条语句中,遵循一致性,保持变量名的规范风格。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论