代码规范的必要性
一、规范的代码可以促进团队合作。
二、规范的代码可以减少bug处理。
三、规范的代码可以降低维护成本。
四、规范的代码有助于代码审查。
五、有助于程序员自身的成长。
代码规范的几大原则
(1)空行
规则一:定义变量后要空行。尽可能在定义变量的同时初始化该变量,即遵循就近原则。如果变量的引用和定义相隔比较远,那么变量的初始化就很容易被忘记。若引用了未被初始化的变量,就会导致程序出错。
规则二:每个函数定义结束之后都要加空行。不同功能之间加空行更加清晰。
(2)空格
规则一:关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格,否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号以突出关键字。
规则二:函数名之后不要留空格,应紧跟左括号以与关键字区别。
规则三:(向后紧跟;)、,、;这三个向前紧跟;紧跟处不留空格。
规则四:,之后要留空格。如果;不是一行的结束符号,其后要留空格。
规则五:赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符,如 =、==、!=、+= 等双目运算符的前后应当加空格。
规则六:单目运算符 !、~、++、--、-、*、& 等前后不加空格。
规则七:像数组符号[ ]、结构体成员运算符.、指向结构体成员运算符->,这类操作符前后不加空格。
规则八:对于表达式比较长的 for 语句和 if 语句,为了紧凑起见,可以适当地去掉一些空格。但 for 和 if 后面紧跟的空格不可以删,其后面的语句可以根据语句的长度适当地去掉一些空格。
(3)缩进
Tab 键实现。原则是:如果地位相等,则不需要缩进;如果属于某一个代码的内部代码就需要缩进。
(4)代码行
规则一:一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且便于写注释。
规则二:if、else、for、while、do 等语句自占一行,执行语句不得紧跟其后。此外,非常重要的一点是,不论执行语句有多少行,就算只有一行也要加{},并且遵循对齐的原则,这样可以防止书写失误。
(5)注释
在一般情况下,源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码,但注意不可过多地使用注释。
规则一:注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主。
规则二:边写代码边注释,修改代码的同时要修改相应的注释。
规则三:当代码比较长,特别是有多重嵌套的时候,应当在段落的结束处加注释,这样便于阅读。
规则四:每一条宏定义的右边必须要有注释,说明其作用。
阿里&Google命名规则
文件命名规则
文件名全部小写,可以含下划线或连字符,按项目约定命名,且尽量保证文件名明确。
类命名规则
类型命名每个单词首字母大写,不含下划线,以名词形式。比如:
MyPalyerManager
变量命名规则
变量名一律小写,单词用下划线相连,例如:
int player_id;
string table_name;
特殊的是类成员变量,后跟下划线区别普通变量,比如:
player_name_
player_id_
全局变量则以 g_
开头,比如 :
g_system_time
当然结构体成员变量还是和普通变量一样,比如:
string name;
int num_entries;
常量命名规则
k
后面跟大写字母开头的单词,比如:
const int kDaysInAWeek=7;
const string kCompanyName=”Tecent”;
函数命名规则
常规函数每个单词首字母大写,使用命令式语气,比如:
OpenFile()
CheckFileName()
而存取函数或短小的内联函数使用小写加下划线,且与访问变量相吻合,比如
set_num_errors()
名字空间命名
命名空间全小写,并基于项目名称和目录结构,比如
google_awesome_project
枚举命名规则
枚举类名属于类型名,按类命名,枚举值全大写加下划线,比如:
ENUM_NAME
宏变量命名规则
如果你一定要用到宏,全大写加下划线,比如:
define PI_ROUND 3.0
数学之美读后感
数学之美这本书可以说是数学原理在计算机领域的应用。这本书深刻地揭示了数学作为一门基础学科,在解决实际问题中的无穷魅力,可以说计算机领域研究的越深入,数学发挥的作用就越大。数学的精妙在于其简洁但极强的表达能力,能够将复杂的事物通过公式和定理联系起来。数学就像一座桥梁,连接理论和实际,抽象和具体。
在本书的众多章节中,给我最深印象的是隐马尔可夫模型。我本身对自然语言处理领域抱有兴趣,隐马尔可夫模型到目前为止一直被认为是解决大多数自然语言处理问题最快速有效的方法。人类的自然语言本就复杂,想要机器去理解更是不容易,人们曾经试图站在语言学的角度去解决这个问题,但成效甚微。面对复杂的问题,人们最终找到的模型也许很复杂,也许很简单。隐马尔可夫模型就是一个简单的模型,它假设随机过程中的各个状态只与它的前一个状态有关,这为之前很多不好解决的问题给出了近似解,极大地推动了语音识别、机器翻译等的发展,让我不得不由衷的感叹数学之美。
这本书启发我如何化繁为简,如何用数学去解决工程问题,如何跳出固有思维去思考创新,让我深刻感受到了数学的重要性。未来我会重视数学的学习,不断探索未知领域。